> ## 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. # Get agent settings > Returns an agent's settings (the settings its manifest declares, with values) for the organization or, with `realm_id`, a realm; without `id`, a summary for every agent. Secrets are masked unless you hold `agents.reveal`. Requires a signed-in user token; with `realm_id`, a realm member (or higher) with the `agents.view` permission on that realm; with `org_id`, a role with the `agents.view` permission in that organization. With neither, the results are limited to what you can see. ## OpenAPI ````yaml /openapi/hub-by-tag/hub-agents.yaml post /v1/agents/get_settings 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/get_settings: post: tags: - Agents summary: Get agent settings description: >- Returns an agent's settings (the settings its manifest declares, with values) for the organization or, with `realm_id`, a realm; without `id`, a summary for every agent. Secrets are masked unless you hold `agents.reveal`. Requires a signed-in user token; with `realm_id`, a realm member (or higher) with the `agents.view` permission on that realm; with `org_id`, a role with the `agents.view` permission in that organization. With neither, the results are limited to what you can see. operationId: POST_v1_agents_get_settings 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 id: type: string format: uuid description: >- When set, return SettingsData for that catalog row; omit for a summary list realm_id: type: string format: uuid description: >- When set, resolve realm overrides; realm must belong to org_id required: - org_id examples: default: value: org_id: 2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f id: 5a6b7c8d-9e0f-4a1b-8c2d-3e4f5a6b7c8d realm_id: 5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b responses: '200': description: Success. content: application/json: schema: type: object required: - ok - data properties: ok: type: boolean enum: - true description: Always `true` on success. data: oneOf: - $ref: '#/components/schemas/SettingsData' - type: array items: $ref: '#/components/schemas/SettingsData' example: ok: true data: id: 5a6b7c8d-9e0f-4a1b-8c2d-3e4f5a6b7c8d name: jira-sync values: api_token: ••••a1b2 base_url: https://acme.atlassian.net all_required_configured: true '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 can see the realm or organization but your role lacks the required permission. `forbidden`: `realm_id` is not a realm of the organization. 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 forbidden (endpoint): summary: forbidden (endpoint) value: ok: false error: realm does not belong to the requested organization code: forbidden '404': description: >- `not_found`: The realm or organization you named does not exist or you cannot see it. `not_found`: No agent has this id. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: not_found: summary: not_found value: ok: false error: code: not_found message: Not found not_found (endpoint): summary: not_found (endpoint) value: ok: false error: agent id '5a6b7c8d-9e0f-4a1b-8c2d-3e4f5a6b7c8d' not found code: not_found '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: SettingsData: type: object properties: id: type: string format: uuid description: Catalog row UUID (round-trip for get_settings / update_settings) name: type: string description: Subject name (e.g. agent catalog name) version: type: string nullable: true description: Subject version, or null when unversioned description: type: string nullable: true description: Subject summary is_system: type: boolean description: True for platform built-ins settings: type: object properties: required: type: array items: type: object properties: key: type: string description: Setting key as declared on the subject schema description: type: string description: Human-readable help for the key default: type: object additionalProperties: true description: Default value when unset when: type: object additionalProperties: type: string description: Conditional visibility map (key → required value) secret: type: boolean description: >- True for credentials (API keys, tokens). Values are masked in get_settings without agents.reveal type: type: string enum: - text - secret - mcp_servers description: >- How the UI edits the value: text (default), secret, or mcp_servers (JSON server list edited with the manifest mcp block) required: - key description: Required setting definitions from the schema optional: type: array items: type: object properties: key: type: string description: Setting key as declared on the subject schema description: type: string description: Human-readable help for the key default: type: object additionalProperties: true description: Default value when unset when: type: object additionalProperties: type: string description: Conditional visibility map (key → required value) secret: type: boolean description: >- True for credentials (API keys, tokens). Values are masked in get_settings without agents.reveal type: type: string enum: - text - secret - mcp_servers description: >- How the UI edits the value: text (default), secret, or mcp_servers (JSON server list edited with the manifest mcp block) required: - key description: Optional setting definitions from the schema required: - required - optional description: Schema split into required vs optional keys values: type: object additionalProperties: type: string description: Resolved string values by key source: type: object additionalProperties: type: string enum: - org - realm nullable: true description: Where each value was set (org, realm, or unset) inherited: type: object additionalProperties: type: boolean description: True when the value is inherited rather than local configured: type: object additionalProperties: type: boolean description: True when the key has a non-empty resolved value required_total: type: number description: Count of required keys required_configured: type: number description: Count of required keys that are configured optional_total: type: number description: Count of optional keys optional_configured: type: number description: Count of optional keys that are configured all_required_configured: type: boolean description: True when every required key is configured mcp: type: object additionalProperties: true description: >- The agent manifest's mcp block (transports, allow_custom, presets) when the agent supports MCP servers required: - id - name - version - description - is_system - settings - values - source - inherited - configured - required_total - required_configured - optional_total - optional_configured - all_required_configured 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.