### GET /v1/workspaces

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/workspaces

```markdown
### Responses

#### 200 - Workspaces retrieved successfully

**WorkspaceListResponse**
- **total_count** (integer (int32)) (required)
- **user_id** (string (uuid)) (required)
- **workspaces** (array (object)) (required)
  Array items:
    - **created_at** (string,null)
    - **currency** (string,null)
    - **description** (string,null)
    - **estimated_cost** (number,null)
    - **feature_count** (integer,null)
    - **filesystem_path** (string,null)
    - **id** (string (uuid)) (required)
    - **is_active** (boolean) (required)
    - **last_accessed** (string,null)
    - **name** (string) (required)
    - **progress** (null)
    - **railway_deployment_url** (string,null)
    - **railway_service_id** (string,null)
    - **score** (integer,null)
    - **settings** (object) (required): Workspace settings
      - **agent_timeout_seconds** (integer (int64)) (required)
      - **allowed_file_types** (array (string)) (required)
      - **auto_save** (boolean) (required)
      - **custom_config** (object) (required)
      - **max_file_size_mb** (integer (int64)) (required)
      - **python_environment** (string,null)
      - **shared_resources** (boolean) (required)
    - **status** (string,null)
    - **storage_used_mb** (integer (int64)) (required)
    - **timeline_minutes** (integer,null)
    - **updated_at** (string,null)
    - **user_id** (string (uuid)) (required)
    - **workspace_type** (string (personal|team|project)) (required): Workspace type enumeration ("personal"|"team"|"project")

#### 401 - Invalid or missing API key

**AuthenticationErrorResponse**
- **details** (string,null): Additional details about the authentication error (example: "API key must start with 'kol__' prefix")
- **error** (string) (required): Authentication error code (example: "unauthorized")
- **message** (string) (required): Human readable error message (example: "Invalid or missing API key")

#### 500 - Workspace list retrieval failed

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/workspaces"
```

```

--------------------------------

### GET /v1/workspaces/order

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/workspaces/order

```markdown
### Responses

#### 200 - Workspace order retrieved successfully

**WorkspaceOrderResponse**
- **order** (array (string (uuid))) (required)
- **user_id** (string (uuid)) (required)

#### 401 - Invalid or missing API key

**AuthenticationErrorResponse**
- **details** (string,null): Additional details about the authentication error (example: "API key must start with 'kol__' prefix")
- **error** (string) (required): Authentication error code (example: "unauthorized")
- **message** (string) (required): Human readable error message (example: "Invalid or missing API key")

#### 500 - Failed to get workspace order

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/workspaces/order"
```

```

--------------------------------

### GET /v1/workspaces/order/stats

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/workspaces/order/stats

```markdown
### Responses

#### 200 - Ordering stats retrieved successfully

**OrderingStats**
- **category_order_count** (integer) (required)
- **feature_order_count** (integer) (required)
- **workspace_order_count** (integer) (required)

#### 401 - Invalid or missing API key

**AuthenticationErrorResponse**
- **details** (string,null): Additional details about the authentication error (example: "API key must start with 'kol__' prefix")
- **error** (string) (required): Authentication error code (example: "unauthorized")
- **message** (string) (required): Human readable error message (example: "Invalid or missing API key")

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/workspaces/order/stats"
```

```

--------------------------------

### GET /v1/workspaces/stats

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/workspaces/stats

```markdown
### Responses

#### 200 - Workspace statistics retrieved successfully

**WorkspaceStatsResponse**
- **allowed_types** (array (string (personal|team|project))) (required)
- **max_workspaces** (integer (int32)) (required)
- **remaining_slots** (integer (int32)) (required)
- **total_workspaces** (integer (int32)) (required)
- **user_id** (string (uuid)) (required)

#### 401 - Invalid or missing API key

**AuthenticationErrorResponse**
- **details** (string,null): Additional details about the authentication error (example: "API key must start with 'kol__' prefix")
- **error** (string) (required): Authentication error code (example: "unauthorized")
- **message** (string) (required): Human readable error message (example: "Invalid or missing API key")

#### 500 - Workspace statistics retrieval failed

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/workspaces/stats"
```

```

--------------------------------

### GET /v1/agent/tools

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/agent/tools

```markdown
### Responses

#### 200 - Success

**ToolsResponse**
- **tools** (unknown) (required)

#### 500 - Server error

Server error

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/agent/tools"
```

```

--------------------------------

### GET /v1/detect/stats

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/detect/stats

```markdown
### Responses

#### 200 - response

**StatsResp**

#### 500 - response

**ErrResp**
- **detail** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/detect/stats"
```

```

--------------------------------

### GET /v1/cache

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/cache

```markdown
### Responses

#### 200 - response

**CacheStatsResp**

#### 500 - response

**ErrResp**
- **detail** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/cache"
```

```

--------------------------------

### GET /v1/models

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/models

```markdown
### Responses

#### 200 - List of available models

**ModelsListResponse**
- **count** (integer) (required): Total count of models
- **models** (array (object)) (required): List of available models
  Array items:
    - **contextSize** (integer (int32)) (required): Context size (maximum tokens) (example: 131072)
    - **id** (string) (required): Model identifier (example: "meta-llama/llama-4-maverick-17b-128e-instruct")
    - **lastUpdated** (string) (required): Last updated timestamp (example: "2025-11-03T06:20:01.997006+00:00")
    - **name** (string) (required): Model display name (example: "Llama 4 Maverick")
    - **pricing** (object) (required): Model pricing information
      - **currency** (string) (required): Currency (example: "USD")
      - **input** (number (double)) (required): Input token price (example: 0.2)
      - **output** (number (double)) (required): Output token price (example: 0.6)
      - **unit** (string) (required): Pricing unit (example: "per 1M tokens")

#### 401 - Invalid or missing API key

**AuthenticationErrorResponse**
- **details** (string,null): Additional details about the authentication error (example: "API key must start with 'kol__' prefix")
- **error** (string) (required): Authentication error code (example: "unauthorized")
- **message** (string) (required): Human readable error message (example: "Invalid or missing API key")

#### 500 - Failed to retrieve models

**ChatCompletionError**
- **error** (object) (required): Error details
  - **code** (string,null): Error code (optional)
  - **message** (string) (required): Error message (example: "Invalid model specified")
  - **param** (string,null): Parameter that caused the error (optional)
  - **type** (string) (required): Error type (example: "invalid_request_error")

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/models"
```

```

--------------------------------

### GET /v1/workspaces/{workspace_id}

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/workspaces/{workspace_id}

```markdown
### Parameters

- **workspace_id** (string, path, required): Workspace ID

### Responses

#### 200 - Workspace retrieved successfully

**WorkspaceResponse**
- **workspace** (object) (required): Workspace data model
  - **created_at** (string,null)
  - **currency** (string,null)
  - **description** (string,null)
  - **estimated_cost** (number,null)
  - **feature_count** (integer,null)
  - **filesystem_path** (string,null)
  - **id** (string (uuid)) (required)
  - **is_active** (boolean) (required)
  - **last_accessed** (string,null)
  - **name** (string) (required)
  - **progress** (null)
  - **railway_deployment_url** (string,null)
  - **railway_service_id** (string,null)
  - **score** (integer,null)
  - **settings** (object) (required): Workspace settings
    - **agent_timeout_seconds** (integer (int64)) (required)
    - **allowed_file_types** (array (string)) (required)
    - **auto_save** (boolean) (required)
    - **custom_config** (object) (required)
    - **max_file_size_mb** (integer (int64)) (required)
    - **python_environment** (string,null)
    - **shared_resources** (boolean) (required)
  - **status** (string,null)
  - **storage_used_mb** (integer (int64)) (required)
  - **timeline_minutes** (integer,null)
  - **updated_at** (string,null)
  - **user_id** (string (uuid)) (required)
  - **workspace_type** (string (personal|team|project)) (required): Workspace type enumeration ("personal"|"team"|"project")

#### 401 - Invalid or missing API key

**AuthenticationErrorResponse**
- **details** (string,null): Additional details about the authentication error (example: "API key must start with 'kol__' prefix")
- **error** (string) (required): Authentication error code (example: "unauthorized")
- **message** (string) (required): Human readable error message (example: "Invalid or missing API key")

#### 404 - Workspace not found or access denied

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

#### 500 - Workspace retrieval failed

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/workspaces/{workspace_id}"
```

```

--------------------------------

### Security: Authorization

Source: https://api.kolosal.ai/openapi.json

kolosal api Key authentication (REQUIRED). Provide your API key in the Authorization header as 'Bearer <your_api_key>'. API keys must start with 'kol__' prefix. 

Example: Bearer kol__your_api_key_here 

This is the default authentication scheme for all endpoints except documentation endpoints.

```markdown
## Security: Authorization

**Description:** kolosal api Key authentication (REQUIRED). Provide your API key in the Authorization header as 'Bearer <your_api_key>'. API keys must start with 'kol__' prefix. 

Example: Bearer kol__your_api_key_here 

This is the default authentication scheme for all endpoints except documentation endpoints.

**Type:** apiKey


```

--------------------------------

### GET /v1/workspaces/{workspace_id}/categories/{category_id}/features/order

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/workspaces/{workspace_id}/categories/{category_id}/features/order

```markdown
### Parameters

- **workspace_id** (string, path, required): Workspace ID
- **category_id** (string, path, required): Category ID

### Responses

#### 200 - Feature order retrieved successfully

**FeatureOrderResponse**
- **category_id** (string (uuid)) (required)
- **order** (array (string (uuid))) (required)

#### 401 - Invalid or missing API key

**AuthenticationErrorResponse**
- **details** (string,null): Additional details about the authentication error (example: "API key must start with 'kol__' prefix")
- **error** (string) (required): Authentication error code (example: "unauthorized")
- **message** (string) (required): Human readable error message (example: "Invalid or missing API key")

#### 403 - Access denied to workspace

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

#### 500 - Failed to get feature order

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/workspaces/{workspace_id}/categories/{category_id}/features/order"
```

```

--------------------------------

### GET /v1/workspaces/{workspace_id}/categories/{category_id}/features/{feature_id}

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/workspaces/{workspace_id}/categories/{category_id}/features/{feature_id}

```markdown
### Parameters

- **workspace_id** (string, path, required): Workspace ID
- **category_id** (string, path, required): Category ID
- **feature_id** (string, path, required): Feature ID

### Responses

#### 200 - Feature found

**FeatureResponse**
- **feature** (object) (required): Feature data model
  - **category_id** (string,null)
  - **created_at** (string,null)
  - **feature_description** (string,null)
  - **feature_id** (string (uuid)) (required)
  - **feature_name** (string) (required)
  - **feature_score** (integer,null)
  - **updated_at** (string,null)

#### 403 - Access denied

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

#### 404 - Not found

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/workspaces/{workspace_id}/categories/{category_id}/features/{feature_id}"
```

```

--------------------------------

### GET /v1/agent/stats

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/agent/stats

```markdown
### Responses

#### 200 - Success

**StatsResponse**
- **healthy** (boolean) (required)
- **stats** (object) (required)
  - **active_streams** (integer (int64)) (required)
  - **failed_requests** (integer (int64)) (required)
  - **success_rate** (number (double)) (required)
  - **successful_requests** (integer (int64)) (required)
  - **total_requests** (integer (int64)) (required)
  - **total_tokens_processed** (integer (int64)) (required)

#### 500 - Server error

Server error

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/agent/stats"
```

```

--------------------------------

### GET /v1/workspaces/{workspace_id}/categories/order

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/workspaces/{workspace_id}/categories/order

```markdown
### Parameters

- **workspace_id** (string, path, required): Workspace ID

### Responses

#### 200 - Category order retrieved successfully

**CategoryOrderResponse**
- **order** (array (string (uuid))) (required)
- **workspace_id** (string (uuid)) (required)

#### 401 - Invalid or missing API key

**AuthenticationErrorResponse**
- **details** (string,null): Additional details about the authentication error (example: "API key must start with 'kol__' prefix")
- **error** (string) (required): Authentication error code (example: "unauthorized")
- **message** (string) (required): Human readable error message (example: "Invalid or missing API key")

#### 403 - Access denied to workspace

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

#### 500 - Failed to get category order

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/workspaces/{workspace_id}/categories/order"
```

```

--------------------------------

### GET /v1/workspaces/{workspace_id}/status

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/workspaces/{workspace_id}/status

```markdown
### Parameters

- **workspace_id** (string, path, required): Workspace ID

### Responses

#### 200 - Workspace status retrieved successfully

**WorkspaceStatusResponse**
- **status** (object) (required)
  - **created_at** (string,null)
  - **deployment_status** (null)
  - **deployment_url** (string,null)
  - **is_active** (boolean) (required)
  - **last_accessed** (string,null)
  - **last_deployed_at** (string,null)
  - **workspace_id** (string (uuid)) (required)
  - **workspace_name** (string) (required)

#### 401 - Invalid or missing API key

**AuthenticationErrorResponse**
- **details** (string,null): Additional details about the authentication error (example: "API key must start with 'kol__' prefix")
- **error** (string) (required): Authentication error code (example: "unauthorized")
- **message** (string) (required): Human readable error message (example: "Invalid or missing API key")

#### 404 - Workspace not found or access denied

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

#### 500 - Workspace status retrieval failed

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/workspaces/{workspace_id}/status"
```

```

--------------------------------

### GET /v1/workspaces/{workspace_id}/categories/{category_id}

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/workspaces/{workspace_id}/categories/{category_id}

```markdown
### Parameters

- **workspace_id** (string, path, required): Workspace ID
- **category_id** (string, path, required): Category ID

### Responses

#### 200 - Category found

**CategoryResponse**
- **category** (object) (required): Category data model
  - **category_description** (string,null)
  - **category_id** (string (uuid)) (required)
  - **category_name** (string) (required)
  - **category_score** (integer,null)
  - **category_type** (string (Business|Technical)) (required): Category type enumeration ("Business"|"Technical")
  - **created_at** (string,null)
  - **updated_at** (string,null)
  - **workspace_id** (string (uuid)) (required)

#### 403 - Access denied

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

#### 404 - Not found

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/workspaces/{workspace_id}/categories/{category_id}"
```

```

--------------------------------

### GET /v1/workspaces/{workspace_id}/categories

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/workspaces/{workspace_id}/categories

```markdown
### Parameters

- **workspace_id** (string, path, required): Workspace ID

### Responses

#### 200 - Categories with order

**CategoryListResponse**
- **categories** (array (object)) (required)
  Array items:
    - **category_description** (string,null)
    - **category_id** (string (uuid)) (required)
    - **category_name** (string) (required)
    - **category_score** (integer,null)
    - **category_type** (string (Business|Technical)) (required): Category type enumeration ("Business"|"Technical")
    - **created_at** (string,null)
    - **updated_at** (string,null)
    - **workspace_id** (string (uuid)) (required)
- **total_count** (integer (int32)) (required)
- **workspace_id** (string (uuid)) (required)

#### 403 - Access denied

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/workspaces/{workspace_id}/categories"
```

```

--------------------------------

### GET /v1/workspaces/{workspace_id}/categories/{category_id}/features

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/workspaces/{workspace_id}/categories/{category_id}/features

```markdown
### Parameters

- **workspace_id** (string, path, required): Workspace ID
- **category_id** (string, path, required): Category ID

### Responses

#### 200 - Features with order

**FeatureListResponse**
- **category_id** (string,null)
- **features** (array (object)) (required)
  Array items:
    - **category_id** (string,null)
    - **created_at** (string,null)
    - **feature_description** (string,null)
    - **feature_id** (string (uuid)) (required)
    - **feature_name** (string) (required)
    - **feature_score** (integer,null)
    - **updated_at** (string,null)
- **total_count** (integer (int32)) (required)

#### 403 - Access denied

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/workspaces/{workspace_id}/categories/{category_id}/features"
```

```

--------------------------------

### Schema: WorkspaceSettings

Source: https://api.kolosal.ai/openapi.json

Workspace settings

```markdown
## Schema: WorkspaceSettings

Workspace settings

**Type:** object

- **agent_timeout_seconds** (integer (int64)) (required)
- **allowed_file_types** (array (string)) (required)
- **auto_save** (boolean) (required)
- **custom_config** (object) (required)
- **max_file_size_mb** (integer (int64)) (required)
- **python_environment** (string,null)
- **shared_resources** (boolean) (required)

```

--------------------------------

### Schema: GitHubRepoConfig

Source: https://api.kolosal.ai/openapi.json

GitHub repository configuration for workspace deployment

```markdown
## Schema: GitHubRepoConfig

GitHub repository configuration for workspace deployment

**Type:** object

- **branch** (string,null): Branch name to clone (defaults to "main" if not specified)
- **oauth_token** (string,null): OAuth token for private repository access (optional for public repos)
- **repo_url** (string) (required): GitHub repository URL (e.g., "https://github.com/owner/repo" or "owner/repo")

```

--------------------------------

### Schema: ChatToolChoice

Source: https://api.kolosal.ai/openapi.json

Tool choice specification

```markdown
## Schema: ChatToolChoice

Tool choice specification

**Type:** object


```

--------------------------------

### Schema: DeploymentStatus

Source: https://api.kolosal.ai/openapi.json

Deployment status flags for efficient bitwise state checks

```markdown
## Schema: DeploymentStatus

Deployment status flags for efficient bitwise state checks

**Type:** string


```

--------------------------------

### POST /v1/chat/completions

Source: https://api.kolosal.ai/openapi.json

Create a chat completion with support for function calling and structured outputs.

```markdown
### Request Body

**Content-Type:** application/json

- **max_tokens** (integer,null): Maximum number of tokens to generate (example: 1000)
- **messages** (array (object)) (required): List of messages for the conversation
  Array items:
    - **content** (string): Content of the message (optional for tool call messages) (example: "Hi, how are you today?")
    - **role** (string) (required): Role of the message author (example: "user")
- **model** (string) (required): Model to use for completion (example: "meta-llama/llama-4-maverick-17b-128e-instruct")

### Responses

#### 200 - Chat completion successful

**ChatCompletionResponse**
- **choices** (array (object)) (required): List of completion choices
  Array items:
    - **finish_reason** (string,null): Reason the generation finished (example: "stop")
    - **index** (integer (int32)) (required): Index of this choice (example: 0)
    - **logprobs** (unknown): Log probabilities (if requested)
    - **message** (object) (required): Response message from the assistant
      - **content** (string,null): Generated content (example: "Hello! How can I help you today?")
      - **refusal** (string,null): Refusal message (if the model refused to answer)
      - **role** (string) (required): Role (always "assistant" for responses) (example: "assistant")
      - **tool_calls** (array,null): Tool calls (if any)
- **created** (integer (int64)) (required): Unix timestamp of when the completion was created (example: 1718366676)
- **id** (string) (required): Unique identifier for the completion (example: "chatcmpl-9V7Vs8sgm8xb6gW4qPzYa8ZJt2b8f")
- **model** (string) (required): Model used for the completion (example: "meta-llama/llama-4-maverick-17b-128e-instruct")
- **object** (string) (required): Object type (always "chat.completion") (example: "chat.completion")
- **service_tier** (string,null): Service tier used (example: "default")
- **system_fingerprint** (string,null): System fingerprint for the model
- **usage** (null)

#### 400 - Invalid request

**ChatCompletionError**
- **error** (object) (required): Error details
  - **code** (string,null): Error code (optional)
  - **message** (string) (required): Error message (example: "Invalid model specified")
  - **param** (string,null): Parameter that caused the error (optional)
  - **type** (string) (required): Error type (example: "invalid_request_error")

#### 401 - Invalid or missing API key

**AuthenticationErrorResponse**
- **details** (string,null): Additional details about the authentication error (example: "API key must start with 'kol__' prefix")
- **error** (string) (required): Authentication error code (example: "unauthorized")
- **message** (string) (required): Human readable error message (example: "Invalid or missing API key")

#### 500 - Chat completion failed

**ChatCompletionError**
- **error** (object) (required): Error details
  - **code** (string,null): Error code (optional)
  - **message** (string) (required): Error message (example: "Invalid model specified")
  - **param** (string,null): Parameter that caused the error (optional)
  - **type** (string) (required): Error type (example: "invalid_request_error")

### Example Usage

```bash
curl -X POST "https://api.kolosal.ai/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -d '{
  "max_tokens": 1000,
  "messages": [
    {
      "content": "Hi, how are you today?",
      "role": "user"
    }
  ],
  "model": "meta-llama/llama-4-maverick-17b-128e-instruct"
}'
```

```

--------------------------------

### Schema: WorkspaceProgress

Source: https://api.kolosal.ai/openapi.json

Workspace progress enumeration representing development stages

```markdown
## Schema: WorkspaceProgress

Workspace progress enumeration representing development stages

**Type:** string


```

--------------------------------

### GET /v1/detect/health

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /v1/detect/health

```markdown
### Responses

#### 200 - response

**HealthResp**
- **device** (string) (required)
- **model_loaded** (boolean) (required)
- **status** (string) (required)
- **version** (string) (required)

#### 500 - response

**ErrResp**
- **detail** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/v1/detect/health"
```

```

--------------------------------

### Schema: WorkspaceStatsResponse

Source: https://api.kolosal.ai/openapi.json

User's workspace statistics and limits

```markdown
## Schema: WorkspaceStatsResponse

User's workspace statistics and limits

**Type:** object

- **allowed_types** (array (string (personal|team|project))) (required)
- **max_workspaces** (integer (int32)) (required)
- **remaining_slots** (integer (int32)) (required)
- **total_workspaces** (integer (int32)) (required)
- **user_id** (string (uuid)) (required)

```

--------------------------------

### Schema: ChatTool

Source: https://api.kolosal.ai/openapi.json

Tool definition for function calling

```markdown
## Schema: ChatTool

Tool definition for function calling

**Type:** object

- **function** (object) (required): Function definition
  - **description** (string,null): Function description
  - **name** (string) (required): Function name
  - **parameters** (unknown): Function parameters as JSON schema
- **type** (string) (required): Type of tool (always "function")

```

--------------------------------

### Schema: ChatToolCall

Source: https://api.kolosal.ai/openapi.json

Tool call made by the assistant

```markdown
## Schema: ChatToolCall

Tool call made by the assistant

**Type:** object

- **function** (object) (required): Function call details
  - **arguments** (string) (required): Function arguments as JSON string
  - **name** (string) (required): Function name
- **id** (string) (required): Tool call ID
- **type** (string) (required): Type of tool call (always "function")

```

--------------------------------

### Schema: Workspace

Source: https://api.kolosal.ai/openapi.json

Workspace data model

```markdown
## Schema: Workspace

Workspace data model

**Type:** object

- **created_at** (string,null)
- **currency** (string,null)
- **description** (string,null)
- **estimated_cost** (number,null)
- **feature_count** (integer,null)
- **filesystem_path** (string,null)
- **id** (string (uuid)) (required)
- **is_active** (boolean) (required)
- **last_accessed** (string,null)
- **name** (string) (required)
- **progress** (null)
- **railway_deployment_url** (string,null)
- **railway_service_id** (string,null)
- **score** (integer,null)
- **settings** (object) (required): Workspace settings
  - **agent_timeout_seconds** (integer (int64)) (required)
  - **allowed_file_types** (array (string)) (required)
  - **auto_save** (boolean) (required)
  - **custom_config** (object) (required)
  - **max_file_size_mb** (integer (int64)) (required)
  - **python_environment** (string,null)
  - **shared_resources** (boolean) (required)
- **status** (string,null)
- **storage_used_mb** (integer (int64)) (required)
- **timeline_minutes** (integer,null)
- **updated_at** (string,null)
- **user_id** (string (uuid)) (required)
- **workspace_type** (string (personal|team|project)) (required): Workspace type enumeration ("personal"|"team"|"project")

```

--------------------------------

### GET /health/detailed

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /health/detailed

```markdown
### Responses

#### 200 - Service is healthy

**DetailedHealthResponse**
- **memory_usage_mb** (integer (int64)) (required): Memory usage in MB (example: 128)
- **status** (string) (required): Service health status (example: "healthy")
- **timestamp** (string) (required): Timestamp of health check (example: "2025-10-25T10:30:00Z")
- **uptime_seconds** (integer (int64)) (required): Uptime in seconds (example: 3600)
- **version** (string) (required): Service version (example: "0.1.0")

#### 401 - Invalid or missing API key

**AuthenticationErrorResponse**
- **details** (string,null): Additional details about the authentication error (example: "API key must start with 'kol__' prefix")
- **error** (string) (required): Authentication error code (example: "unauthorized")
- **message** (string) (required): Human readable error message (example: "Invalid or missing API key")

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/health/detailed"
```

```

--------------------------------

### GET /health

Source: https://api.kolosal.ai/openapi.json

API endpoint for GET /health

```markdown
### Responses

#### 200 - Service is healthy

**SecureHealthResponse**
- **status** (string) (required): Service health status (example: "healthy")
- **timestamp** (string) (required): Timestamp of health check (example: "2025-10-25T10:30:00Z")

#### 401 - Invalid or missing API key

**AuthenticationErrorResponse**
- **details** (string,null): Additional details about the authentication error (example: "API key must start with 'kol__' prefix")
- **error** (string) (required): Authentication error code (example: "unauthorized")
- **message** (string) (required): Human readable error message (example: "Invalid or missing API key")

### Example Usage

```bash
curl -X GET "https://api.kolosal.ai/health"
```

```

--------------------------------

### Schema: ChatPromptTokensDetails

Source: https://api.kolosal.ai/openapi.json

Detailed prompt token information

```markdown
## Schema: ChatPromptTokensDetails

Detailed prompt token information

**Type:** object

- **audio_tokens** (integer,null): Number of audio tokens (example: 0)
- **cached_tokens** (integer,null): Number of cached tokens (example: 0)

```

--------------------------------

### POST /v1/workspaces

Source: https://api.kolosal.ai/openapi.json

API endpoint for POST /v1/workspaces

```markdown
### Request Body

**Content-Type:** application/json

- **currency** (string,null): Optional currency code (e.g., USD, EUR)
- **description** (string,null)
- **estimated_cost** (number,null): Optional estimated cost
- **github_repo** (null)
- **name** (string) (required)
- **progress** (null)
- **settings** (null)
- **timeline_minutes** (integer,null): Optional timeline in minutes
- **workspace_type** (string (personal|team|project)) (required): Workspace type enumeration ("personal"|"team"|"project")

### Responses

#### 200 - Workspace created successfully

**WorkspaceResponse**
- **workspace** (object) (required): Workspace data model
  - **created_at** (string,null)
  - **currency** (string,null)
  - **description** (string,null)
  - **estimated_cost** (number,null)
  - **feature_count** (integer,null)
  - **filesystem_path** (string,null)
  - **id** (string (uuid)) (required)
  - **is_active** (boolean) (required)
  - **last_accessed** (string,null)
  - **name** (string) (required)
  - **progress** (null)
  - **railway_deployment_url** (string,null)
  - **railway_service_id** (string,null)
  - **score** (integer,null)
  - **settings** (object) (required): Workspace settings
    - **agent_timeout_seconds** (integer (int64)) (required)
    - **allowed_file_types** (array (string)) (required)
    - **auto_save** (boolean) (required)
    - **custom_config** (object) (required)
    - **max_file_size_mb** (integer (int64)) (required)
    - **python_environment** (string,null)
    - **shared_resources** (boolean) (required)
  - **status** (string,null)
  - **storage_used_mb** (integer (int64)) (required)
  - **timeline_minutes** (integer,null)
  - **updated_at** (string,null)
  - **user_id** (string (uuid)) (required)
  - **workspace_type** (string (personal|team|project)) (required): Workspace type enumeration ("personal"|"team"|"project")

#### 400 - Invalid request

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

#### 401 - Invalid or missing API key

**AuthenticationErrorResponse**
- **details** (string,null): Additional details about the authentication error (example: "API key must start with 'kol__' prefix")
- **error** (string) (required): Authentication error code (example: "unauthorized")
- **message** (string) (required): Human readable error message (example: "Invalid or missing API key")

#### 500 - Workspace creation failed

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.kolosal.ai/v1/workspaces" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "value",
  "description": "value",
  "estimated_cost": "value",
  "github_repo": "value",
  "name": "string",
  "progress": "value",
  "settings": "value",
  "timeline_minutes": "value",
  "workspace_type": "personal"
}'
```

```

--------------------------------

### Schema: ChatChoice

Source: https://api.kolosal.ai/openapi.json

Individual completion choice

```markdown
## Schema: ChatChoice

Individual completion choice

**Type:** object

- **finish_reason** (string,null): Reason the generation finished (example: "stop")
- **index** (integer (int32)) (required): Index of this choice (example: 0)
- **logprobs** (unknown): Log probabilities (if requested)
- **message** (object) (required): Response message from the assistant
  - **content** (string,null): Generated content (example: "Hello! How can I help you today?")
  - **refusal** (string,null): Refusal message (if the model refused to answer)
  - **role** (string) (required): Role (always "assistant" for responses) (example: "assistant")
  - **tool_calls** (array,null): Tool calls (if any)

```

--------------------------------

### Schema: CreateWorkspaceRequest

Source: https://api.kolosal.ai/openapi.json

Request structures for workspace operations

```markdown
## Schema: CreateWorkspaceRequest

Request structures for workspace operations

**Type:** object

- **currency** (string,null): Optional currency code (e.g., USD, EUR)
- **description** (string,null)
- **estimated_cost** (number,null): Optional estimated cost
- **github_repo** (null)
- **name** (string) (required)
- **progress** (null)
- **settings** (null)
- **timeline_minutes** (integer,null): Optional timeline in minutes
- **workspace_type** (string (personal|team|project)) (required): Workspace type enumeration ("personal"|"team"|"project")

```

--------------------------------

### Schema: UsageInfo

Source: https://api.kolosal.ai/openapi.json

Schema definition for UsageInfo

```markdown
## Schema: UsageInfo

Schema definition for UsageInfo

**Type:** object

- **cached_tokens** (integer,null)
- **completion_tokens** (integer (int64)) (required)
- **prompt_tokens** (integer (int64)) (required)
- **thinking_tokens** (integer,null)
- **total_tokens** (integer (int64)) (required)

```

--------------------------------

### PUT /v1/workspaces/order

Source: https://api.kolosal.ai/openapi.json

API endpoint for PUT /v1/workspaces/order

```markdown
### Request Body

**Content-Type:** application/json

- **order** (array (string (uuid))) (required)

### Responses

#### 200 - Workspace order updated successfully

**WorkspaceOrderResponse**
- **order** (array (string (uuid))) (required)
- **user_id** (string (uuid)) (required)

#### 400 - Invalid request

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

#### 401 - Invalid or missing API key

**AuthenticationErrorResponse**
- **details** (string,null): Additional details about the authentication error (example: "API key must start with 'kol__' prefix")
- **error** (string) (required): Authentication error code (example: "unauthorized")
- **message** (string) (required): Human readable error message (example: "Invalid or missing API key")

#### 500 - Failed to update workspace order

**WorkspaceError**
- **details** (string,null)
- **error** (string) (required)
- **message** (string) (required)

### Example Usage

```bash
curl -X PUT "https://api.kolosal.ai/v1/workspaces/order" \
  -H "Content-Type: application/json" \
  -d '{
  "order": [
    "string"
  ]
}'
```

```

--------------------------------

### Schema: CreateCategoryRequest

Source: https://api.kolosal.ai/openapi.json

Category request/response structures

```markdown
## Schema: CreateCategoryRequest

Category request/response structures

**Type:** object

- **category_description** (string,null)
- **category_name** (string) (required)
- **category_score** (integer,null)
- **category_type** (string (Business|Technical)) (required): Category type enumeration ("Business"|"Technical")
- **workspace_id** (string (uuid)) (required)

```

--------------------------------

### Schema: WorkspaceResponse

Source: https://api.kolosal.ai/openapi.json

Schema definition for WorkspaceResponse

```markdown
## Schema: WorkspaceResponse

Schema definition for WorkspaceResponse

**Type:** object

- **workspace** (object) (required): Workspace data model
  - **created_at** (string,null)
  - **currency** (string,null)
  - **description** (string,null)
  - **estimated_cost** (number,null)
  - **feature_count** (integer,null)
  - **filesystem_path** (string,null)
  - **id** (string (uuid)) (required)
  - **is_active** (boolean) (required)
  - **last_accessed** (string,null)
  - **name** (string) (required)
  - **progress** (null)
  - **railway_deployment_url** (string,null)
  - **railway_service_id** (string,null)
  - **score** (integer,null)
  - **settings** (object) (required): Workspace settings
    - **agent_timeout_seconds** (integer (int64)) (required)
    - **allowed_file_types** (array (string)) (required)
    - **auto_save** (boolean) (required)
    - **custom_config** (object) (required)
    - **max_file_size_mb** (integer (int64)) (required)
    - **python_environment** (string,null)
    - **shared_resources** (boolean) (required)
  - **status** (string,null)
  - **storage_used_mb** (integer (int64)) (required)
  - **timeline_minutes** (integer,null)
  - **updated_at** (string,null)
  - **user_id** (string (uuid)) (required)
  - **workspace_type** (string (personal|team|project)) (required): Workspace type enumeration ("personal"|"team"|"project")

```

--------------------------------

### Schema: WorkspaceStatus

Source: https://api.kolosal.ai/openapi.json

Schema definition for WorkspaceStatus

```markdown
## Schema: WorkspaceStatus

Schema definition for WorkspaceStatus

**Type:** object

- **created_at** (string,null)
- **deployment_status** (null)
- **deployment_url** (string,null)
- **is_active** (boolean) (required)
- **last_accessed** (string,null)
- **last_deployed_at** (string,null)
- **workspace_id** (string (uuid)) (required)
- **workspace_name** (string) (required)

```