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

# Preview Spec

> Fetch/parse an OpenAPI spec and return metadata + tools without creating a connection.

The service dependency ensures authentication is enforced.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/openapi-connections/preview-spec
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/openapi-connections/preview-spec:
    post:
      tags:
        - v1
        - protected
        - openapi-connections
      summary: Preview Spec
      description: >-
        Fetch/parse an OpenAPI spec and return metadata + tools without creating
        a connection.


        The service dependency ensures authentication is enforced.
      operationId: preview_spec_v1_openapi_connections_preview_spec_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SpecPreviewRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpecPreviewResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    SpecPreviewRequest:
      properties:
        spec_content:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Spec Content
        spec_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Spec Url
      title: SpecPreviewRequest
      type: object
    SpecPreviewResponse:
      properties:
        base_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Base Url
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        tools:
          default: []
          items:
            additionalProperties:
              type: string
            type: object
          title: Tools
          type: array
        version:
          anyOf:
            - type: string
            - type: 'null'
          title: Version
      title: SpecPreviewResponse
      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

````