v1.0

    API Reference

    Complete REST API documentation for AIConfig Cloud

    RESTful API
    JSON responses
    Rate limited

    Authentication

    All API requests require authentication using Bearer tokens. Include your API key in the Authorization header:

    Authorization: Bearer YOUR_API_KEY

    Getting an API Key

    1. Sign up for a Pro or Enterprise account
    2. Navigate to Settings → API Keys
    3. Click "Generate New Key"
    4. Copy and securely store your key

    Endpoints

    POST
    /api/v1/configs
    Create a new configuration
    Required
    GET
    /api/v1/configs/:id
    Retrieve a specific configuration
    Required
    PUT
    /api/v1/configs/:id
    Update an existing configuration
    Required
    DELETE
    /api/v1/configs/:id
    Delete a configuration
    Required
    POST
    /api/v1/configs/:id/generate
    Generate adapter configs from .aiconfig
    Required
    GET
    /api/v1/adapters
    List available adapters
    Optional
    POST
    /api/v1/validate
    Validate a config without saving
    Required
    GET
    /api/v1/teams/:teamId/configs
    List team configurations
    Required

    Request Examples

    Create Configuration

    Request

    POST /api/v1/configs
    Content-Type: application/json
    Authorization: Bearer YOUR_API_KEY
    
    {
      "name": "my-project-config",
      "content": {
        "version": "1.0",
        "assistant": {
          "name": "My Project Assistant",
          "context": [
            "React TypeScript project",
            "Uses shadcn/ui components"
          ],
          "rules": [
            "Always use functional components",
            "Include prop types"
          ],
          "style": "concise"
        }
      },
      "adapters": ["copilot", "cursor", "windsurf"]
    }

    Response

    HTTP/1.1 201 Created
    Content-Type: application/json
    
    {
      "id": "cfg_1a2b3c4d5e6f",
      "name": "my-project-config",
      "createdAt": "2024-02-15T10:30:00Z",
      "updatedAt": "2024-02-15T10:30:00Z",
      "content": { ... },
      "adapters": ["copilot", "cursor", "windsurf"],
      "generatedConfigs": {
        "copilot": ".copilot/instructions.md",
        "cursor": ".cursorrules",
        "windsurf": ".windsurf/config.json"
      }
    }

    Rate Limits

    Free Tier

    100

    requests/hour

    Pro

    1,000

    requests/hour

    Enterprise

    Custom

    Contact sales