> ## Documentation Index > Fetch the complete documentation index at: https://docs.cloudhumans.com/llms.txt > Use this file to discover all available pages before exploring further. # Create an agent > Administrator only. Invites the agent by email; someone who already has a CloudChat login on another account becomes a member of this one, keeping that login. Consumes one agent license seat — a 402 means the account has none left. export const CloudChatYourValues = () => { const STORAGE_KEY = "cloudchat-api-selected-account"; const CREDENTIALS_HREF = "/api-reference/cloudchat/credentials"; const [saved, setSaved] = useState(null); const [ready, setReady] = useState(false); useEffect(() => { let value = null; try { const raw = window.localStorage.getItem(STORAGE_KEY); if (raw) { const parsed = JSON.parse(raw); if (parsed && parsed.instance && parsed.account) { value = { instance: String(parsed.instance), account: String(parsed.account), name: typeof parsed.name === "string" && parsed.name ? parsed.name : null }; } } } catch (error) { value = null; } setSaved(value); setReady(true); }, []); const shell = "not-prose rounded-xl border border-gray-200 dark:border-white/10 bg-gray-50 dark:bg-white/5 px-4 py-3 mb-6"; if (!ready || !saved) { return

Every request below needs your cloudchat-instance header and your account id.{" "} Paste your token {" "} and they will show up here, ready to copy.

; } return
cloudchat-instance {saved.instance}
accountId {saved.account}
{saved.name && {saved.name}} Change
; }; ## OpenAPI ````yaml api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/agents openapi: 3.0.1 info: title: Cloud Chat API version: v1 description: >- The curated public surface of Cloud Chat. Every call needs two things: the Bearer token from `POST /auth/v1/signin`, and the `cloudchat-instance` header that says which Cloud Chat instance your company lives on. If you don't know your instance value, the [Find your credentials](/api-reference/cloudchat/credentials) page reads it out of your own token in the browser. servers: - url: https://api.cloudhumans.com/cloudchat description: Production security: - bearerAuth: [] tags: - name: Canned Responses description: >- Canned responses — the shortcuts agents expand while replying. Each one belongs to a single account and is identified by its short code. - name: Conversations description: >- Read-only access to the conversations of an account. What you can see follows the same rule as the dashboard: an administrator token sees every inbox, an agent token only the inboxes it is a member of. - name: Help Center description: >- Portals, categories and articles of the help center — the public FAQ your customers read. - name: Uploads description: Store the images help center articles embed. - name: Labels description: >- Read-only access to the labels an account has defined. A label is a tag conversations and contacts carry; this endpoint only lists the label definitions themselves. - name: Inboxes description: >- Read-only access to the inboxes a token can see — every inbox of the account for an administrator, only its memberships for an agent. Never includes the channel's credentials. - name: Agents description: >- Read-only access to the human and AI agents of an account. A hidden admin (the platform's own support user) never appears, on the list or by id. - name: Teams description: >- Teams group agents for assignment. Listing and reading are open to any member; creating and updating a team, and managing its membership, require an administrator token. A system-managed team (provisioned by the platform) can be read like any other but never updated. - name: Macros description: >- Macros bundle a sequence of actions an agent runs against a conversation from the dashboard. This surface lets you list, read and write macro definitions — running one is not part of the v1 contract. A macro is either `global` (visible to the whole account) or `personal` (visible only to its author); an agent token can only create personal macros. - name: Automation Rules description: >- Read-only access to the account's automation rules — administrator only. An agent token gets a 403 on every operation in this group. - name: Availability Reasons description: >- The reasons an agent can go `busy` for, configured per account. Listing is open to any member; creating, updating and deleting require an administrator token. Deleting is a soft delete — the reason disappears from listings but agents' past availability history keeps referencing it. paths: /v1/accounts/{accountId}/agents: parameters: - $ref: '#/components/parameters/CloudChatInstance' - $ref: '#/components/parameters/AccountId' post: tags: - Agents summary: Create an agent description: >- Administrator only. Invites the agent by email; someone who already has a CloudChat login on another account becomes a member of this one, keeping that login. Consumes one agent license seat — a 402 means the account has none left. operationId: createAgent requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AgentCreateRequest' responses: '201': description: Created. content: application/json: schema: $ref: '#/components/schemas/Agent' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/PaymentRequired' '403': description: >- Two situations answer with this code: the account is suspended (the reason every endpoint shares), or your token is not an administrator — this operation requires one. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: forbidden message: You are not allowed to perform this action. '404': description: >- The account does not exist or you are not a member of it — the two are deliberately indistinguishable. Inviting the email of a hidden admin — the platform's own support user — also answers 404. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: not_found message: The requested resource could not be found. '422': description: >- The payload was understood but a value is not acceptable — a blank or already-taken `email`, a `role` or `availability` outside its enum, or an `assignment_limit` that is not a positive integer. `details` names the offending field. content: application/json: schema: $ref: '#/components/schemas/ValidationError' example: error: code: validation_failed message: The request payload is invalid. details: - field: email code: taken message: has already been taken '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' components: parameters: CloudChatInstance: name: cloudchat-instance in: header required: true description: >- Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. [The API overview](/api-reference/cloudchat/overview#two-headers-every-call) explains how instances work, how to find yours, and the errors a wrong or missing value produces. schema: type: integer example: 1 AccountId: name: accountId in: path required: true description: >- Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the `cloudchat-instance` header — the two travel together. Account numbers are only unique **within** an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers. schema: type: integer example: 1 schemas: AgentCreateRequest: type: object description: The agent goes under an `agent` wrapper. Administrator only. required: - agent properties: agent: type: object required: - email properties: email: type: string description: >- Required. Login email the invitation is sent to. Someone who already has a CloudChat login on another account joins this one with that login. example: jane@acme.com name: type: string description: Display name for the agent. example: Jane Doe role: type: string enum: - agent - administrator - supervisor - assistant - cx_engineer description: >- Role on this account. The role grants dashboard permissions — `administrator` can manage account configuration. Defaults to `agent`. example: agent availability: type: string enum: - online - offline - busy description: Initial presence. Defaults to `offline`. example: offline auto_offline: type: boolean description: >- Whether the agent is moved to `offline` automatically after a period of inactivity. Defaults to false. example: false assignment_limit: type: integer nullable: true description: >- Maximum conversations auto-assigned to the agent at once. A positive integer; omit or send `null` for no cap. example: 10 Agent: type: object description: >- A human or AI agent of the account. A hidden admin — the platform's own support user — never appears here, on the list or by id. required: - id - name - email - role - availability_status - auto_offline - assignment_limit - is_ai_agent - team_ids - inbox_ids - created_at - updated_at properties: id: type: integer example: 7 name: type: string example: Jane Doe email: type: string example: jane@acme.com role: type: string enum: - agent - administrator - supervisor - assistant - cx_engineer example: agent availability_status: type: string nullable: true enum: - online - offline - busy example: online auto_offline: type: boolean description: >- Whether the agent is moved to `offline` automatically after a period of inactivity. example: true assignment_limit: type: integer nullable: true description: >- Per-agent override of the account's default conversation assignment limit. `null` when the agent uses the account default. example: null is_ai_agent: type: boolean example: false team_ids: type: array description: Teams the agent belongs to, scoped to this account. items: type: integer example: - 5 inbox_ids: type: array description: Inboxes the agent is a member of, scoped to this account. items: type: integer example: - 3 created_at: type: string format: date-time example: '2026-05-02T11:04:17.000Z' updated_at: type: string format: date-time example: '2026-08-10T14:32:05.123Z' display_name: type: string nullable: true description: >- The name that belongs to this account only, when there is one. It is what `name` shows; `null` means `name` comes from the user's global record. Error: type: object description: The error envelope every Cloud Chat API response uses. required: - error properties: error: type: object required: - code - message properties: code: type: string description: >- The stable, machine-readable reason. Branch on this, never on `message`. enum: - unauthorized - forbidden - not_found - validation_failed - bad_request - internal_error example: not_found message: type: string description: >- The reason in words, localized to your account's language (English, Spanish or Brazilian Portuguese; English when the account is set to anything else). Wording changes with the account and between releases, so never match on it. Two cases stay in English whatever the account is set to: `unauthorized`, decided before any account is known, and the account-level `not_found`, which must not reveal the account's language. example: Resource could not be found. details: type: array description: >- Present on some rejections — a 400 for a refused query parameter or upload mode, for example. One entry per offending field, localized to the account's language like `message` — match on `code` and `field`, never on the text. items: type: object required: - field - code - message properties: field: type: string description: Which request field the rule was about. code: type: string description: Stable, machine-readable reason. message: type: string description: The rule in words. ValidationError: type: object description: A `validation_failed` error, which carries `details`. required: - error properties: error: type: object required: - code - message - details properties: code: type: string enum: - validation_failed example: validation_failed message: type: string description: >- Localized to the account's language, like every other envelope message. example: The request payload is invalid. details: type: array description: >- One entry per rejected field. Unlike the envelope message above, the texts come from the model layer and are in English in practice (the model layer ships no translations) — match on code and field, never on the text. items: type: object required: - field - code - message properties: field: type: string description: >- Which request field the rule was about — `short_code` or `content`. A rule that is not tied to either is reported as `base`, so treat `base` as "the payload as a whole" rather than a field you can highlight. enum: - short_code - content - base example: short_code code: type: string description: >- Which rule it broke — `blank` for a missing or empty value, `taken` for a `short_code` already used on the account. example: taken message: type: string example: has already been taken GatewayError: type: object description: >- Rejected by the gateway before Cloud Chat saw it, so it does not use the `error` envelope. required: - message properties: message: type: string example: API rate limit exceeded request_id: type: string description: Gateway request id. Quote it when reporting a problem. example: f3f7567638d4b65a8003057d0c77d275 responses: BadRequest: description: >- The request itself is malformed, before any value is validated: - a body that isn't valid JSON, or one with no `canned_response` wrapper, - a `canned_response` that isn't an object (`{"canned_response": "text"}`), - `page`, `per_page`, `search` or `sort` sent as an array or a nested object (`?page[]=1`, `?sort[x]=y`) instead of a plain value, - **the `cloudchat-instance` header missing or holding a value we don't route,** - an `accountId` that is not a number — including the literal `{accountId}` that some API clients send when the argument is left unset. This one answers with the normal envelope and `error.details` naming `accountId`, and it is deliberately **not** a 404: a 404 would mean the account cannot be reached, while this means the value was never an account id at all, so re-read the argument instead of trying other numbers. **Two different shapes answer with 400, and the difference will bite you on day one.** That last case is rejected before the request reaches the API, so `error` is a plain **string** instead of the usual object: ```json { "error": "" } ``` Every other 400 uses the normal envelope, where `error` is an object with `code` and `message`. Reading `error.code` without checking the type first throws on the missing-header case — which is the most likely 400 of your first integration. Check `typeof error === "string"` first, or read `error?.code` defensively. A 400 always means fix the request shape; it never means a value was rejected. Rejected values are 422. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: bad_request message: The request is malformed. Unauthorized: description: >- No Bearer token, or one that is expired, malformed, or not a Cognito token. Sign in again for a fresh `id_token`. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: unauthorized message: >- Authentication is required. Send a valid Bearer token in the Authorization header. PaymentRequired: description: >- The account has no agent license seats left. The envelope carries code `limit_exceeded`. Retrying will not help — a human has to purchase more licenses (or free a seat) before another agent can be invited. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: limit_exceeded message: >- The account has reached its agent license limit. Purchase more licenses to add agents. TooManyRequests: description: >- Rate limited per source IP. Note the envelope: this one is `{ "message": ... }`, because the request never reached the API. Don't hardcode the limit — read it from the response. `Retry-After` says how many seconds to wait, and every response (not just this one) carries `ratelimit-limit`, `ratelimit-remaining` and `ratelimit-reset`, the last in seconds. content: application/json: schema: $ref: '#/components/schemas/GatewayError' example: message: API rate limit exceeded InternalError: description: >- Something failed on our side. The response never carries the underlying error, but it is reported to our monitoring automatically — no need to file anything for a one-off. Retrying is reasonable, with one caveat on `POST`: a 500 does not prove the write did not happen, so a retry can come back `422` with `short_code` already taken. That 422 means the first attempt succeeded — list the account and confirm before treating it as a failure. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: internal_error message: An unexpected error occurred. Please try again later. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- The `id_token` from `POST /auth/v1/signin`, sent as `Authorization: Bearer `. Not the `access_token` — that one does not carry the identity Cloud Chat authorizes on. ````