Parcha schemas API

The schemas API from Parcha — 1 operation(s) for schemas.

OpenAPI Specification

parcha-schemas-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Parcha Admin schemas API
  version: 1.0.0
  description: API for managing Parcha jobs and checks
servers:
- url: https://api.parcha.ai/api/v1
  description: Agent Hub API server
- url: https://demo.parcha.ai/api/v1
  description: Sandbox API server
- url: https://us1.parcha.ai/api/v1
  description: Legacy API server
- url: http://{your-company-domain}.parcha.ai/api/v1
  description: Custom Enterpris server (your company's API server)
security:
- bearerAuth: []
tags:
- name: schemas
paths:
  /api/v1/agent-schemas/{agent_key}:
    get:
      tags:
      - schemas
      summary: Get Agent Schemas
      description: 'Get the schema information for all checks in an agent


        This endpoint returns detailed schema information for each check in the specified agent,

        including input and output schemas, check forms, and other metadata.'
      operationId: get_agent_schemas_api_v1_agent_schemas__agent_key__get
      security:
      - HTTPBearer: []
      parameters:
      - name: agent_key
        in: path
        required: true
        schema:
          type: string
          title: Agent Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                title: Response Get Agent Schemas Api V1 Agent Schemas  Agent Key  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key obtained from your Parcha account settings. Include as Bearer token in the Authorization header.