> ## Documentation Index > Fetch the complete documentation index at: https://docs.getcliq.io/llms.txt > Use this file to discover all available pages before exploring further. # Register an agent > Registers a custom agent version from its manifest (`cliq agent register` sends it). Answers `201` for a new registration and `200` when `force` overwrote an existing version. Requires a role with the `agents.manage` permission in the organization given by `org_id`. ## OpenAPI ````yaml /openapi/hub-by-tag/hub-agents.yaml post /v1/agents/register openapi: 3.0.3 info: title: 'CliqHub API: Agents' version: 1.0.0 description: >- The agent catalog: built-in agents that ship with cliq (`is_system: true`, in every organization) and custom agents your organization registers (`cliq agent register`). An agent is identified by organization, name and version; only its manifest is stored here, the code runs on daemons. Agent settings (API keys, models, …) can be set for the organization and overridden per realm; secret values come back masked unless you hold `agents.reveal`. servers: - url: https://{host} variables: host: default: cliqhub.io description: CliqHub host security: [] tags: - name: Agents description: >- The agent catalog: built-in agents that ship with cliq (`is_system: true`, in every organization) and custom agents your organization registers (`cliq agent register`). An agent is identified by organization, name and version; only its manifest is stored here, the code runs on daemons. Agent settings (API keys, models, …) can be set for the organization and overridden per realm; secret values come back masked unless you hold `agents.reveal`. paths: /v1/agents/register: post: tags: - Agents summary: Register an agent description: >- Registers a custom agent version from its manifest (`cliq agent register` sends it). Answers `201` for a new registration and `200` when `force` overwrote an existing version. Requires a role with the `agents.manage` permission in the organization given by `org_id`. operationId: POST_v1_agents_register requestBody: required: true content: application/json: schema: type: object properties: org_id: type: string format: uuid description: >- Organization this call targets. Caller must be authorized for this org name: type: string minLength: 1 description: Catalog name to register under the target org version: type: string minLength: 1 description: Version string; falls back to manifest.version when omitted manifest: oneOf: - type: string minLength: 1 description: Manifest as a YAML or JSON string - type: object additionalProperties: type: object additionalProperties: true description: Already-parsed manifest object description: Agent manifest as YAML/JSON string or already-parsed object description: type: string description: Human-readable summary; falls back to manifest.description agent_type: type: string description: Runtime kind; falls back to manifest.agent_type or exec force: type: boolean description: >- When true, overwrite an existing active (org, name, version) row required: - org_id - name - manifest examples: default: value: org_id: 2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f name: jira-sync version: 0.3.0 agent_type: exec description: Syncs review findings to Jira issues. manifest: name: jira-sync version: 0.3.0 entry: index.js responses: '201': description: Created. content: application/json: schema: type: object required: - ok - data properties: ok: type: boolean enum: - true description: Always `true` on success. data: $ref: '#/components/schemas/AgentData' example: ok: true data: id: 5a6b7c8d-9e0f-4a1b-8c2d-3e4f5a6b7c8d name: jira-sync version: 0.3.0 description: Syncs review findings to Jira issues. agent_type: exec is_system: false created_at: 1759000000000 updated_at: 1759000000000 '400': description: '`bad_request`: The manifest is invalid.' content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: bad_request: summary: bad_request value: ok: false error: 'invalid agent manifest: name is required' code: bad_request '401': description: >- `unauthorized`: No `Authorization` header, or the token is malformed, expired or revoked. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: unauthorized: summary: unauthorized value: ok: false error: code: unauthorized message: Authentication required '403': description: >- `forbidden`: You are a member of the organization but your role lacks the required permission, or a daemon token was used. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: forbidden: summary: forbidden value: ok: false error: code: forbidden message: You do not have access to do this '404': description: >- `not_found`: The organization does not exist or you are not a member. CliqHub answers 404, not 403, so it does not reveal which. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: not_found: summary: not_found value: ok: false error: code: not_found message: Not found '409': description: >- `conflict`: This version is already registered and `force` is not `true`, or the agent was deregistered (an admin must restore it). content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: conflict: summary: conflict value: ok: false error: >- agent jira-sync@0.3.0 already registered in this org (use force to overwrite) code: conflict '422': description: >- `invalid_params`: The body fails the request schema: a required field is missing or a value has the wrong type or format. The message lists every issue as `field: problem`. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: invalid_params: summary: invalid_params value: ok: false error: 'org_id: Required' code: invalid_params '500': description: >- `internal_error`: An unexpected server fault. Retry later; if it persists, report it with the time of the request. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: internal_error: summary: internal_error value: ok: false error: Internal server error code: internal_error security: - BearerAuth: [] components: schemas: AgentData: type: object properties: id: type: string description: Catalog row UUID name: type: string description: Agent name (natural key with org + version) version: type: string nullable: true description: Version string, or null when unversioned description: type: string nullable: true description: Human-readable summary agent_type: type: string description: Runtime kind (e.g. exec, connector) is_system: type: boolean description: True for platform built-ins; false for org-registered custom agents manifest: type: object additionalProperties: type: object additionalProperties: true description: Parsed manifest object when include_manifest was true created_at: type: number description: Row create time (unix ms) updated_at: type: number description: Row last update time (unix ms) used_by: type: array items: type: object properties: scope: type: string description: Team scope name: type: string description: Team name version: type: string nullable: true description: Team version whose workflow was checked (latest published) realm_ids: type: array items: type: string description: This org\ required: - scope - name - version - realm_ids description: >- Present when include_usage was true: teams visible to the org that use this agent required: - id - name - version - description - agent_type - is_system - created_at - updated_at HubErr: type: object required: - ok - error description: >- Every failure. Route-policy denials (401/403/404, and 400 when neither realm_id nor org_id was sent) answer `error` as `{ code, message }`; errors raised by the endpoint answer `error` as the message with the code beside it in `code`. Every error has a code. See [Errors](/hub-api/errors). properties: ok: type: boolean description: Always false on error error: description: The message, or `{ code, message }` for an access denial. oneOf: - type: string - type: object required: - code - message properties: code: type: string message: type: string code: type: string description: Stable error code of an endpoint error. details: type: object additionalProperties: true description: Structured detail, when there is some. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: cliq_tok_* | cliq_dt_* description: >- User PAT (`cliq_tok_…`, including session-scoped) or realm token (`cliq_dt_…`). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.