All Products
Search

This Product

    :API Overview

    Document Center

    :API Overview

    Last Updated:Jul 15, 2026

    The Qoder Cloud Agents API provides full cloud-based AI Agent management capabilities, covering Agent creation, environment configuration, session management, event streaming, and more. All endpoints follow RESTful design and use JSON as the request/response format.

    The API is currently in Beta. Some features may be adjusted in future releases.

    Gateway URL

    Environment

    URL

    Production

    https://api.qoder.com.cn/api/v1/cloud

    Versioning

    The current API version is v1. All endpoints carry the version in the URL path (/v1/), so no separate version header is required.

    Available APIs

    Resource

    Description

    Base path

    Agents

    Create, read, update, delete, and archive Agent instances

    /agents

    Environments

    Manage runtime environment configurations

    /environments

    Sessions

    Create Agent sessions and manage their lifecycle

    /sessions

    Events

    Read and push session event streams

    /events

    Files

    Upload files and manage associations

    /files

    Vaults

    Securely store sensitive credentials

    /vaults

    Skills

    Register and manage Agent skills

    /skills

    Memory Stores

    Persistent memory storage

    /memory_stores

    Deployments

    Scheduled deployment automation

    /deployments

    Forward Templates

    Forward Agent template definition, versioning, archiving, and cloning

    /api/v1/forward/templates

    Forward Identities

    Forward identity creation, enable/disable, deletion, and Agent queries

    /api/v1/forward/identities

    Forward Identity Configs

    Per-identity template configuration and effective configuration queries

    /api/v1/forward/identities/{identity_id}/templates

    Forward Channels

    Forward channel and QR code session management

    /api/v1/forward/channels, /api/v1/forward/qr_sessions

    Forward Sessions

    Forward session lifecycle, events, and SSE streams

    /api/v1/forward/sessions

    Forward Resources

    Forward external resource registration and listing

    /api/v1/forward/resources

    Forward Schedules

    Forward scheduled tasks and run history management

    /api/v1/forward/schedules, /api/v1/forward/schedule_runs

    Request size limits

    • Maximum request body size per call: 4 MB

    • Bodies exceeding the limit are truncated by the server, causing JSON parsing to fail and returning a 400 invalid_request_error (message: "Request body must be valid JSON.")

    Required request headers

    Every API request must include the authorization header. Including Content-Type is recommended:

    Authorization: Bearer $QODER_PAT
Content-Type: application/json  # Recommended but not mandatory; the server can auto-detect

    Beta status

    1. The API is broadly stable, but request signatures may see minor adjustments in future iterations.

    2. New features ship under new beta identifiers.

    3. In production, pin the API version and add compatibility handling.

    4. All current features work without an additional Beta header.

    Quick connectivity check

    # List Agents under the current account to verify authentication and connectivity
curl -s "https://api.qoder.com.cn/api/v1/cloud/agents?limit=1" \
  -H "Authorization: Bearer $QODER_PAT"

    A successful response looks like:

    {
  "data": [],
  "first_id": null,
  "last_id": null,
  "has_more": false
}

    Rate limiting

    No application-level rate limits apply today. The gateway enforces global burst-traffic controls and DDoS protection, which may return 429 or 503 under heavy load. Retry 5xx and 429 responses with exponential backoff (1 s, 2 s, 4 s — up to three attempts).

    What's next