cc
GET /system/queue
Bearer auth

Query parameters

  • limit integer

    Maximum number of results to return (1–100)

    Minimum value is 1, maximum value is 100. Default value is 50.

  • offset integer

    Number of results to skip for pagination

    Minimum value is 0. Default value is 0.

  • platform string

    Values are linux or windows.

  • status string

    Values are queued or running.

Responses

  • 200 application/json

    Queue status and active jobs

    Hide response attributes Show response attributes object
    • data array Required
    • pagination object Required
      Hide pagination attributes Show pagination attributes object
      • limit integer Required

        Minimum value is 1.

      • offset integer Required

        Minimum value is 0.

      • total integer Required

        Minimum value is 0.

      • next_offset integer | null

        Minimum value is 0.

    • queue_depth integer

      Minimum value is 0.

    • running_count integer

      Minimum value is 0.
  • 401 application/json

    Missing, expired, or invalid bearer token

    Hide response attributes Show response attributes object
    • code string Required

      Machine-readable error code (snake_case)

      Maximum length is 100.

    • message string Required

      Human-readable error summary

      Maximum length is 500.

    • details object Required

      Structured context for the error. Always an object, never null. Empty object {} when no additional detail is available.

      Additional properties are allowed.
  • 403 application/json

    Token is valid but lacks the required scope or role

    Hide response attributes Show response attributes object
    • code string Required

      Machine-readable error code (snake_case)

      Maximum length is 100.

    • message string Required

      Human-readable error summary

      Maximum length is 500.

    • details object Required

      Structured context for the error. Always an object, never null. Empty object {} when no additional detail is available.

      Additional properties are allowed.
  • 429 application/json

    Too many requests. Retry after the indicated number of seconds.

    Hide headers attributes Show headers attributes
    • Retry-After integer

      Seconds to wait before retrying

    • X-RateLimit-Limit

      Maximum requests allowed in the current window

    • X-RateLimit-Remaining

      Requests remaining in the current window

    • X-RateLimit-Reset

      Unix timestamp when the rate limit window resets

    Hide response attributes Show response attributes object
    • code string Required

      Machine-readable error code (snake_case)

      Maximum length is 100.

    • message string Required

      Human-readable error summary

      Maximum length is 500.

    • details object Required

      Structured context for the error. Always an object, never null. Empty object {} when no additional detail is available.

      Additional properties are allowed.
  • default application/json

    Unexpected server error

    Hide response attributes Show response attributes object
    • code string Required

      Machine-readable error code (snake_case)

      Maximum length is 100.

    • message string Required

      Human-readable error summary

      Maximum length is 500.

    • details object Required

      Structured context for the error. Always an object, never null. Empty object {} when no additional detail is available.

      Additional properties are allowed.
GET /system/queue 
curl \
 --request GET 'https://sampleplatform.ccextractor.org/api/v1/system/queue' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": [],
  "pagination": {
    "limit": 42,
    "offset": 42,
    "total": 42,
    "next_offset": 42
  },
  "queue_depth": 42,
  "running_count": 42
}
Response examples (401) 
{
  "code": "unauthorized",
  "message": "Bearer token is missing, expired, or invalid.",
  "details": {}
}
Response examples (403) 
{
  "code": "forbidden",
  "message": "Token does not have the required scope for this operation.",
  "details": {
    "required_scope": "runs:write",
    "token_scopes": [
      "runs:read",
      "results:read"
    ]
  }
}
Response examples (429) 
{
  "code": "rate_limited",
  "message": "Rate limit exceeded. Retry after 30 seconds.",
  "details": {
    "retry_after": 30,
    "limit": 120,
    "window": "60s"
  }
}
Response examples (default) 
{
  "code": "not_found",
  "message": "Run 9317 not found.",
  "details": {}
}