API Documentation

Integrate FolderCopilot's AI-powered folder generation into your applications with our RESTful API

Getting Started

The FolderCopilot API allows you to programmatically generate folder structures using our AI engine. All API requests must be authenticated and use HTTPS.

Base URL:

https://api.foldercopilot.com/v1
Authentication

API requests are authenticated using API keys. Include your API key in the Authorization header.

curl -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://api.foldercopilot.com/v1/generate

Note: API keys are available for Pro and Team plan subscribers only.

API Endpoints
POST
/api/v1/generate
Auth Required

Generate a folder structure

GET
/api/v1/projects
Auth Required

List user projects

GET
/api/v1/projects/{id}
Auth Required

Get specific project

DELETE
/api/v1/projects/{id}
Auth Required

Delete a project

Code Examples
const response = await fetch('https://api.foldercopilot.com/v1/generate', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    type: 'course',
    metadata: {
      courseName: 'Introduction to Psychology',
      semester: 'fall',
      courseOutline: 'Course covers basic psychology concepts...'
    }
  })
});

const data = await response.json();
console.log(data.structure);
Rate Limits
100
requests/hour
Pro Plan
500
requests/hour
Team Plan
Custom
Enterprise
Contact Sales
Error Handling

The API uses conventional HTTP response codes to indicate success or failure.

200
Success - Request completed successfully
400
Bad Request - Invalid request parameters
401
Unauthorized - Invalid API key
429
Rate Limited - Too many requests
500
Server Error - Internal server error

Ready to Get Started?

Upgrade to Pro or Team plan to get your API key and start integrating FolderCopilot into your applications.