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

# Preflight Catalog Item

> Report whether a catalog connection can use the platform OAuth app.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/workspaces/{workspace}/connections/catalog/{item_id}/preflight
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.0
servers: []
security:
  - bearer: []
paths:
  /v1/workspaces/{workspace}/connections/catalog/{item_id}/preflight:
    get:
      tags:
        - v1
        - protected
        - connections
      summary: Preflight Catalog Item
      description: Report whether a catalog connection can use the platform OAuth app.
      operationId: preflight_catalog_item_v1_connections_catalog__item_id__preflight_get
      parameters:
        - in: path
          name: item_id
          required: true
          schema:
            format: uuid
            title: 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/CatalogConnectionPreflight'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    CatalogConnectionPreflight:
      description: |-
        What the connect form needs to know before it offers Connect.

        ``ready`` — this installation holds an OAuth app for the provider.
        ``oauth_app_required`` — the user must register their own app first.
      properties:
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        detail:
          title: Detail
          type: string
        item_id:
          format: uuid
          title: Item Id
          type: string
        name:
          title: Name
          type: string
        redirect_uri:
          title: Redirect Uri
          type: string
        status:
          enum:
            - ready
            - oauth_app_required
          title: Status
          type: string
      required:
        - item_id
        - name
        - status
        - detail
        - redirect_uri
      title: CatalogConnectionPreflight
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      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

````