Protobox API

The Protobox REST API lets you manage your workspace programmatically — ingest and search knowledge, and authenticate. All operations are scoped to a workspace.

Base URL

• Production: https://platform.protobox.ai

Sections

Authentication

The API supports two authentication methods.

API Keys

For programmatic access with a workspace-scoped key:

{
  "headers": {
    "X-API-Key": "<api_key>"
  }
}

JWT Bearer Tokens

For user authentication via the platform login flow:

{
  "headers": {
    "Authorization": "Bearer <jwt_token>"
  }
}

Rate Limiting

Requests are rate-limited per workspace. Rate limit headers are returned on all responses:

• X-RateLimit-Limit — requests per window
• X-RateLimit-Remaining — remaining requests in the window
• X-RateLimit-Reset — when the limit resets

Error Handling

The API uses standard HTTP status codes and returns detailed error information:

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": {
      "field": "title",
      "issue": "title should not be empty"
    }
  }
}

See the Error Reference for the full list of error codes.