For AI agents: the complete documentation index is available at https://docs.clickmax.io/en/llms.txt, the full documentation bundle is available at https://docs.clickmax.io/en/llms-full.txt, and this page is available as Markdown at https://docs.clickmax.io/en/reference/api/index.md.
  • English
  • Clickmax API

    Use the Clickmax API at https://mcp.clickmax.io/api/v0/. Every request requires Bearer authentication.

    Interactive referenceExplore the API by endpointReview parameters, request examples, and response schemas in one place.Open reference
    v0 is still unstable

    The 0 in /api/v0/ indicates that this version can still change. Endpoints, parameters, and responses may change without prior notice. Always check the published schema before updating your integration.

    Authentication

    Workspace owners and admins create and revoke keys under Settings > Connections > API. Each workspace can keep up to 5 keys.

    The key is displayed only after creation and cannot be viewed again. To replace a key or change its allowed IP addresses, revoke it and create another one.

    The prefix identifies the environment: cxp_ for production, cxs_ for staging, and cxd_ for development.

    A key without allowed IP addresses works from any IP. When the list is populated, the API accepts only the exact IPv4 or IPv6 addresses provided.

    Send the key with every request:

    Authorization: Bearer <api-key>

    API keys do not authenticate MCP connections. MCP continues to use OAuth.

    Request limit

    The public API accepts up to 100 requests every 10 seconds per workspace. All API keys in the workspace share this limit.

    When the limit is exceeded, the API returns 429 rate limit exceeded. Wait a few seconds before trying again, and reduce concurrent requests if the error continues.

    Other resources

    ResourceWhen to use it
    OpenAPI YAML schemaRead the current contract, generate clients, or give the schema directly to an AI agent.
    Clickmax MCPConnect AI clients that support MCP and OAuth.