> ## Documentation Index
> Fetch the complete documentation index at: https://docs.goclicks.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Download the OpenAPI schema

> Return the OpenAPI 3.1 document that describes this API.

The document is the same contract this reference renders from. Use it to
generate typed clients. The endpoint requires no authentication.



## OpenAPI

````yaml openapi.mintlify.json GET /v1/openapi.json
openapi: 3.1.0
info:
  description: >-
    Run your configured Clicks agents programmatically: create an agent run and
    poll its status and transcript.


    Authenticate with a per-agent API key created on the agent's **API access**
    tab. Send it as `Authorization: Bearer <key>` (preferred) or `X-API-Key:
    <key>`.
  title: Clicks Agents API
  version: '1.0'
servers:
  - description: US production
    url: https://app.us.goclicks.ai
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - description: Create agent runs and read their status and transcript.
    name: public-api
    x-displayName: Agents
paths:
  /v1/openapi.json:
    get:
      tags:
        - public-api
      summary: Download the OpenAPI schema
      description: |-
        Return the OpenAPI 3.1 document that describes this API.

        The document is the same contract this reference renders from. Use it to
        generate typed clients. The endpoint requires no authentication.
      operationId: public_get_openapi_schema
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                title: Response Public Get Openapi Schema
                type: object
          description: Successful Response
      security: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl "https://app.us.goclicks.ai/v1/openapi.json" \
              -o openapi.public.json
        - lang: python
          label: Python
          source: |-
            import requests

            resp = requests.get("https://app.us.goclicks.ai/v1/openapi.json")
            resp.raise_for_status()
            schema = resp.json()
            print(schema["info"]["title"], schema["info"]["version"])
components:
  securitySchemes:
    bearerAuth:
      description: API key (`ak_...`) as a Bearer token. Preferred.
      scheme: bearer
      type: http
    apiKeyHeader:
      description: >-
        API key (`ak_...`) as a header. Used only when the `Authorization`
        header is missing or not a Bearer credential.
      in: header
      name: X-API-Key
      type: apiKey

````