Skip to main content
Conventions

API Overview

Introduction to the Qoder Cloud Agents API, gateway URL, request limits, and required headers.

The Qoder Cloud Agents API provides full management capabilities for cloud-hosted AI Agents, covering Agent creation, environment configuration, session management, event streaming, and more. All endpoints follow REST conventions and use JSON for requests and responses.
The API is currently in Beta. Some functionality may change in future releases.

Gateway URL

EnvironmentURL
Production (Managed Mode)https://api.qoder.com/api/v1/cloud
Production (Forward Mode)https://api.qoder.com/api/v1/forward

Versioning

The API is currently at version v1. Endpoints use the mode-specific /api/v1/cloud or /api/v1/forward prefix; no additional version header is required.

Available APIs

ResourceDescriptionBase path
AgentsAgent CRUD and archival/agents
EnvironmentsRuntime environment configuration/environments
SessionsAgent session creation and lifecycle/sessions
EventsSession event stream reads and pushes/events
FilesFile upload and association/files
VaultsSecure storage for sensitive credentials/vaults
SkillsAgent skill registration and management/skills
Memory StoresPersistent memory storage/memory_stores
DeploymentsScheduled deployment automation/deployments
WorkSelf-hosted Environment work queue and worker lease lifecycle/environments/{environment_id}/work
Forward TemplatesForward agent template definition, versioning, archiving, and cloning/api/v1/forward/templates
Forward IdentitiesForward identity creation, enable/disable, deletion, and agent lookup/api/v1/forward/identities
Forward Identity ConfigsPer-identity template config and effective config lookup/api/v1/forward/identities/{identity_id}/templates
Forward ChannelsForward channel and QR session management/api/v1/forward/channels, /api/v1/forward/qr_sessions
Forward SessionsForward session lifecycle, events, and SSE streams/api/v1/forward/sessions
Forward EnvironmentsForward environment lifecycle management/api/v1/forward/environments
Forward SkillsForward Skill lifecycle management/api/v1/forward/skills
Forward VaultsForward Vault lifecycle management/api/v1/forward/vaults
Forward CredentialsVault-scoped credential management/api/v1/forward/vaults/{vault_id}/credentials
Forward FilesForward file upload, retrieval, download, and deletion/api/v1/forward/files
Forward SchedulesForward scheduled tasks and run record management/api/v1/forward/schedules, /api/v1/forward/schedule_runs

Request size limits

  • Maximum request body size: 4 MB
  • Requests exceeding this limit are truncated, causing JSON parsing to fail with 400 invalid_request_error (message: "Request body must be valid JSON.").

Required headers

Every API request must include the authentication header; Content-Type is recommended but not mandatory — the server can auto-detect:
Authorization: Bearer $QODER_PAT
Content-Type: application/json  # recommended but not mandatory, server can auto-detect

Beta status

  1. The API surface is broadly stable, but signatures may receive minor adjustments in future iterations.
  2. New functionality ships behind new beta identifiers.
  3. Lock the API version and add compatibility handling when running in production.
  4. When using a Beta feature, declare its identifier with x-qoder-beta.
Beta identifierSurfaceGuide
browser-use-2026-07-14browser_toolset_20260714, browser tools, and live previewBrowser Use (Beta)

Quick connectivity check

# List Agents under the current account (verifies auth and connectivity)
curl -s https://api.qoder.com/api/v1/cloud/agents?limit=1 \
  -H "Authorization: Bearer $QODER_PAT"
Successful response:
{
  "data": [],
  "first_id": null,
  "last_id": null,
  "has_more": false
}

Rate Limiting

The API application layer currently has no active rate limiting. The gateway layer has global burst traffic suppression and DDoS protection, which may return 429 or 503 when triggered. Clients should implement exponential backoff retry for 5xx/429 (1s → 2s → 4s, max 3 retries).

Next steps