> ## 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.

# List local agents

> Lists every agent found on the agents path, with its version, type and folder. With
`check_reg: true` each row also says whether the agent is registered in your CliqHub
organization; if CliqHub cannot be asked, every agent reads as not registered.

From the CLI: `cliq agent list`.

No credential is needed from this machine. From another host, send `Authorization: Bearer` with a dispatch token CliqHub signed for this daemon or a `cliq_tok_…` personal token of a user in the daemon's realm; this only works once the daemon is connected to CliqHub. See [Authentication](/daemon-api/overview#authentication).



## OpenAPI

````yaml /openapi/daemon-by-tag/daemon-agents.yaml post /v1/agents/get
openapi: 3.1.0
info:
  title: cliqd API
  version: 1.9.48
  description: >-
    HTTP API of `cliqd`, the local Cliq daemon. Generated from the daemon source
    by `scripts/generate_daemon_openapi.mjs` — do not edit by hand. See the
    [overview](/daemon-api/overview).
servers:
  - url: http://127.0.0.1:4900
    description: Local daemon (default port; `CLIQ_DAEMON_PORT` changes it)
security: []
tags:
  - name: Daemon Agents
    description: >-
      Agents this daemon can run, found on its **agents path**
      (`CLIQ_AGENTS_PATH` or the

      `agents.path` setting; `~/.cliqrc/agents` is always searched last), and
      their

      registration in your CliqHub organization. Built-in agents ship with cliq;
      a custom agent

      is a folder with an agent manifest. Teams that use a custom agent can only
      be published and

      run through CliqHub once the agent is registered there.
paths:
  /v1/agents/get:
    post:
      tags:
        - Daemon Agents
      summary: List local agents
      description: >-
        Lists every agent found on the agents path, with its version, type and
        folder. With

        `check_reg: true` each row also says whether the agent is registered in
        your CliqHub

        organization; if CliqHub cannot be asked, every agent reads as not
        registered.


        From the CLI: `cliq agent list`.


        No credential is needed from this machine. From another host, send
        `Authorization: Bearer` with a dispatch token CliqHub signed for this
        daemon or a `cliq_tok_…` personal token of a user in the daemon's realm;
        this only works once the daemon is connected to CliqHub. See
        [Authentication](/daemon-api/overview#authentication).
      operationId: daemon_post_agents_get
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                check_reg:
                  description: Also check each agent's registration on Hub
                  type: boolean
            examples:
              default:
                value: {}
              check:
                summary: Also check CliqHub registration
                value:
                  check_reg: true
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                required:
                  - ok
                  - data
                properties:
                  ok:
                    type: boolean
                    const: true
                  data:
                    $ref: '#/components/schemas/LocalAgentList'
              example:
                ok: true
                data:
                  agents:
                    - name: claude-code
                      version: 1.2.0
                      description: Runs Claude Code on the workspace.
                      agent_type: exec
                      source_dir: /opt/cliq/agents
                      dir: /opt/cliq/agents/claude-code
                      registered: true
                    - name: jira-sync
                      version: 0.3.0
                      description: Syncs review findings to Jira issues.
                      agent_type: exec
                      source_dir: /home/dev/.cliqrc/agents
                      dir: /home/dev/.cliqrc/agents/jira-sync
                      registered: false
                  path:
                    - /opt/cliq/agents
                    - /home/dev/.cliqrc/agents
                  realm: acme.production
        '400':
          description: >-
            `PAYLOAD_INVALID` — The body (query string for `GET`) fails the
            request schema. `details` lists each issue.


            `BAD_REQUEST` — The body is not valid JSON or is larger than the
            route allows (10 MB; artifact uploads more).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReply'
              examples:
                PAYLOAD_INVALID:
                  summary: PAYLOAD_INVALID
                  value:
                    ok: false
                    error:
                      code: PAYLOAD_INVALID
                      message: Payload failed schema validation
                BAD_REQUEST:
                  summary: BAD_REQUEST
                  value:
                    ok: false
                    error:
                      code: BAD_REQUEST
                      message: >-
                        Request body could not be read: Unexpected token } in
                        JSON at position 12
        '401':
          description: >-
            `UNAUTHORIZED` — A caller on another host sent no `Authorization:
            Bearer` token, or one that does not verify (expired, wrong
            audience).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReply'
              examples:
                UNAUTHORIZED:
                  summary: UNAUTHORIZED
                  value:
                    ok: false
                    error:
                      code: UNAUTHORIZED
                      message: Missing or invalid Authorization Bearer token
        '403':
          description: >-
            `WEB_REQUEST_REFUSED` — The request carries an `Origin` header (it
            came from a web page).


            `HOST_NOT_LOCAL` — A loopback caller addressed a `Host` other than
            localhost (DNS rebinding guard).


            `LOCAL_ONLY` — The daemon isn't connected to CliqHub (no dispatch
            key) and the caller is on another host.


            `FORBIDDEN` — A `cliq_tok_…` token's user is not in this daemon's
            realm ACL, or the ACL is not loaded yet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReply'
              examples:
                WEB_REQUEST_REFUSED:
                  summary: WEB_REQUEST_REFUSED
                  value:
                    ok: false
                    error:
                      code: WEB_REQUEST_REFUSED
                      message: cliqd doesn't accept requests from web pages
                HOST_NOT_LOCAL:
                  summary: HOST_NOT_LOCAL
                  value:
                    ok: false
                    error:
                      code: HOST_NOT_LOCAL
                      message: cliqd only answers requests addressed to localhost
                LOCAL_ONLY:
                  summary: LOCAL_ONLY
                  value:
                    ok: false
                    error:
                      code: LOCAL_ONLY
                      message: >-
                        This cliqd isn't connected to CliqHub yet, so from
                        another machine it only accepts a local token (minted by
                        tokens/create on the machine running cliqd)
                FORBIDDEN:
                  summary: FORBIDDEN
                  value:
                    ok: false
                    error:
                      code: FORBIDDEN
                      message: Access denied — identity not in realm ACL
        '500':
          description: >-
            `INTERNAL_ERROR` — An unexpected daemon fault. The message names the
            request id; the cause is in the cliqd log.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReply'
              examples:
                INTERNAL_ERROR:
                  summary: INTERNAL_ERROR
                  value:
                    ok: false
                    error:
                      code: INTERNAL_ERROR
                      message: >-
                        cliqd hit an unexpected error (request 7f3a…). Details
                        are in the cliqd log.
      security:
        - {}
        - DaemonBearer: []
components:
  schemas:
    LocalAgentList:
      type: object
      required:
        - agents
        - path
        - realm
      properties:
        agents:
          type: array
          items:
            $ref: '#/components/schemas/LocalAgent'
        path:
          type: array
          items:
            type: string
          description: The agents path, in search order.
          example:
            - /home/dev/agents
            - /home/dev/.cliqrc/agents
        realm:
          type:
            - string
            - 'null'
          description: >-
            The realm this daemon is enrolled in (`org.realm`), for display;
            `null` when not enrolled.
          example: acme.production
    ErrorReply:
      type: object
      description: >-
        Every failure. Switch on `error.code` — it is stable; `message` is for
        people and may change.
      required:
        - ok
        - error
      properties:
        ok:
          type: boolean
          const: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Stable error code. See [Errors](/daemon-api/errors).
              example: TEAM_NOT_FOUND
            message:
              type: string
              description: What went wrong and, where possible, what to do.
              example: Team 'acme/code-review' not found
            details:
              description: >-
                Structured detail when there is some: the list of schema issues
                for `PAYLOAD_INVALID`, the agent problems for
                `TEAM_AGENT_CONFIG_REQUIRED`, …
    LocalAgent:
      type: object
      description: An agent found on the agents path.
      required:
        - name
        - version
        - description
        - agent_type
        - source_dir
        - dir
      properties:
        name:
          type: string
          example: jira-sync
        version:
          type:
            - string
            - 'null'
          description: From the manifest.
          example: 0.3.0
        description:
          type:
            - string
            - 'null'
          example: Syncs review findings to Jira issues.
        agent_type:
          type: string
          description: From the manifest; `exec` when not set.
          example: exec
        source_dir:
          type: string
          description: The agents-path entry it was found under.
          example: /home/dev/.cliqrc/agents
        dir:
          type: string
          description: The agent's own folder.
          example: /home/dev/.cliqrc/agents/jira-sync
        registered:
          type: boolean
          description: >-
            Only with `check_reg`: an agent with this name is registered in your
            CliqHub organization.
          example: true
  securitySchemes:
    DaemonBearer:
      type: http
      scheme: bearer
      description: >-
        Not needed from the same machine. From another host: a dispatch JWT
        CliqHub signed for this daemon, or a `cliq_tok_…` personal token whose
        user is in the daemon's realm.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.