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

# Connect Catalog Api

> Connect a catalog API with its keys; each call makes another connection.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/workspaces/{workspace}/openapi-connections/from-catalog/{catalog_item_id}
openapi: 3.1.0
info:
  description: >-
    Modular and extensible framework for building AI agents. This API requires
    JWT Bearer token authentication for most endpoints. Include your JWT token
    in the Authorization header. Public endpoints include /, /health, /docs,
    /redoc, and /openapi.json.
  title: AgentArea API
  version: 0.1.2
servers: []
security:
  - bearer: []
paths:
  /v1/workspaces/{workspace}/openapi-connections/from-catalog/{catalog_item_id}:
    post:
      tags:
        - v1
        - protected
        - openapi-connections
      summary: Connect Catalog Api
      description: Connect a catalog API with its keys; each call makes another connection.
      operationId: >-
        connect_catalog_api_v1_openapi_connections_from_catalog__catalog_item_id__post
      parameters:
        - in: path
          name: catalog_item_id
          required: true
          schema:
            format: uuid
            title: Catalog Item Id
            type: string
        - description: Slug of the workspace the request acts in
          in: path
          name: workspace
          required: true
          schema:
            description: Slug of the workspace the request acts in
            maxLength: 120
            pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
            title: Workspace
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CatalogConnectRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenAPIConnectionResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    CatalogConnectRequest:
      additionalProperties: false
      description: The keys a catalog API asks for, one per field of its connect form.
      properties:
        credentials:
          items:
            $ref: '#/components/schemas/CatalogKeyValue'
          maxItems: 16
          minItems: 1
          title: Credentials
          type: array
      required:
        - credentials
      title: CatalogConnectRequest
      type: object
    OpenAPIConnectionResponse:
      properties:
        auth_config_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Auth Config Id
        available_tools:
          items:
            $ref: '#/components/schemas/OpenAPIToolResponse'
          title: Available Tools
          type: array
        base_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Base Url
        cost:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Cost
        created_at:
          format: date-time
          title: Created At
          type: string
        custom_headers:
          anyOf:
            - items:
                $ref: '#/components/schemas/HeaderOutput'
              type: array
            - type: 'null'
          title: Custom Headers
        custom_query_params:
          anyOf:
            - items:
                $ref: '#/components/schemas/QueryParamOutput'
              type: array
            - type: 'null'
          title: Custom Query Params
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        id:
          format: uuid
          title: Id
          type: string
        last_dispatch:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Last Dispatch
        managed_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Managed By
        name:
          title: Name
          type: string
        registry_item_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Registry Item Id
        spec_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Spec Url
        status:
          title: Status
          type: string
        updated_at:
          format: date-time
          title: Updated At
          type: string
        url_variables:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Url Variables
      required:
        - id
        - name
        - base_url
        - available_tools
        - status
        - created_at
        - updated_at
      title: OpenAPIConnectionResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    CatalogKeyValue:
      additionalProperties: false
      properties:
        name:
          maxLength: 256
          title: Name
          type: string
        value:
          maxLength: 8192
          title: Value
          type: string
      required:
        - name
        - value
      title: CatalogKeyValue
      type: object
    OpenAPIToolResponse:
      properties:
        description:
          title: Description
          type: string
        inputSchema:
          additionalProperties: true
          title: Inputschema
          type: object
        name:
          title: Name
          type: string
      required:
        - name
        - description
        - inputSchema
      title: OpenAPIToolResponse
      type: object
    HeaderOutput:
      description: Header metadata returned in API responses (secret values are masked).
      properties:
        name:
          title: Name
          type: string
        secret:
          title: Secret
          type: boolean
        value:
          anyOf:
            - type: string
            - type: 'null'
          title: Value
      required:
        - name
        - secret
      title: HeaderOutput
      type: object
    QueryParamOutput:
      description: >-
        Query parameter metadata returned in API responses (secret values are
        masked).
      properties:
        name:
          title: Name
          type: string
        secret:
          title: Secret
          type: boolean
        value:
          anyOf:
            - type: string
            - type: 'null'
          title: Value
      required:
        - name
        - secret
      title: QueryParamOutput
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    bearer:
      bearerFormat: JWT
      description: JWT Bearer token for authentication
      scheme: bearer
      type: http
    HTTPBearer:
      scheme: bearer
      type: http

````

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