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

# Get Catalog Connect Form

> What connecting this catalog API asks for: a sign-in, or the keys listed in ``fields``.



## OpenAPI

````yaml /api-reference/openapi.json get /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}:
    get:
      tags:
        - v1
        - protected
        - openapi-connections
      summary: Get Catalog Connect Form
      description: >-
        What connecting this catalog API asks for: a sign-in, or the keys listed
        in ``fields``.
      operationId: >-
        get_catalog_connect_form_v1_openapi_connections_from_catalog__catalog_item_id__get
      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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogConnectFormResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    CatalogConnectFormResponse:
      description: 'How a catalog API is connected: by signing in, or by entering its keys.'
      properties:
        auth:
          enum:
            - oauth
            - api_key
          title: Auth
          type: string
        catalog_item_id:
          format: uuid
          title: Catalog Item Id
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        fields:
          items:
            $ref: '#/components/schemas/CatalogKeyFieldResponse'
          title: Fields
          type: array
        name:
          title: Name
          type: string
      required:
        - catalog_item_id
        - name
        - auth
      title: CatalogConnectFormResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    CatalogKeyFieldResponse:
      description: One value a catalog API needs before it can be called.
      properties:
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        label:
          description: What the vendor calls it, for the form.
          title: Label
          type: string
        location:
          enum:
            - header
            - query
          title: Location
          type: string
        name:
          description: Header or query parameter the value is sent in.
          title: Name
          type: string
      required:
        - name
        - location
        - label
      title: CatalogKeyFieldResponse
      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.