info:
  title: Hyperforge
  description: API reference for Hyperforge retrieval agent endpoints.
  version: v1
openapi: 3.1.0
servers:
- url: https://{region-x}.dp.stashify.cloud/api/v1
  description: Development server
tags:
- name: Audit
  description: Audit log and download request endpoints.
- name: Drivers
  description: Driver configuration endpoints.
- name: Import Export
  description: Retrieval Agent import and export endpoints.
- name: MCP
  description: Model Context Protocol interaction endpoints.
- name: Prompt Management
  description: Prompt configuration endpoints.
- name: Sessions
  description: Session management endpoints.
- name: Workflow Agents
  description: Workflow Agent configuration and interaction endpoints.
- name: Workflows
  description: Workflow configuration endpoints.
paths:
  /agent/{agent_id}/audit/download_request/{request_id}:
    delete:
      tags:
      - Audit
      summary: Delete Download Request
      description: Delete a download request by its ID
      operationId: delete_download_request_api_v1_agent__agent_id__audit_download_request__request_id__delete
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: request_id
        in: path
        required: true
        schema:
          type: string
          title: Request Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/audit/download_request/{request_id}/status:
    get:
      tags:
      - Audit
      summary: Get Download Request Status
      description: Get status of an audit download request by its ID
      operationId: get_download_request_status_api_v1_agent__agent_id__audit_download_request__request_id__status_get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: request_id
        in: path
        required: true
        schema:
          type: string
          title: Request Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadStatus'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/audit/download_requests:
    get:
      tags:
      - Audit
      summary: List Download Requests
      description: List all download requests for the account
      operationId: list_download_requests_api_v1_agent__agent_id__audit_download_requests_get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DownloadStatus'
                title: Response List Download Requests Api V1 Agent  Agent Id  Audit
                  Download Requests Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/audit/interactions/download:
    post:
      tags:
      - Audit
      summary: Request Interactions Audit Download
      description: Request a download for the audit log of an agent's interactions
      operationId: request_interactions_audit_download_api_v1_agent__agent_id__audit_interactions_download_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: accept
        in: header
        required: false
        schema:
          enum:
          - application/x-ndjson
          - text/csv
          type: string
          default: text/csv
          title: Accept
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InteractionsAuditDownloadRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadStatus'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/driver/{driver}:
    patch:
      tags:
      - Drivers
      summary: Patch Driver
      description: Set Agent Configuration
      operationId: patch_driver_api_v1_agent__agent_id__driver__driver__patch
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: driver
        in: path
        required: true
        schema:
          type: string
          title: Driver
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DriverConfig'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Drivers
      summary: Delete Driver
      description: Set Agent Configuration
      operationId: delete_driver_api_v1_agent__agent_id__driver__driver__delete
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: driver
        in: path
        required: true
        schema:
          type: string
          title: Driver
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/drivers:
    post:
      tags:
      - Drivers
      summary: Add Driver
      description: Set Agent Configuration
      operationId: add_driver_api_v1_agent__agent_id__drivers_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DriverConfig'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverID'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Drivers
      summary: Get Drivers
      description: Get Agent Configuration
      operationId: get_drivers_api_v1_agent__agent_id__drivers_get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
                title: Response Get Drivers Api V1 Agent  Agent Id  Drivers Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/export:
    post:
      tags:
      - Import Export
      summary: Request Export Retrieval Agent
      description: Request the export of a Retrieval Agent. This will send an email
        with a download link to the email associated with the account.
      operationId: request_export_retrieval_agent_api_v1_agent__agent_id__export_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrievalAgentExportRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/generation:
    post:
      tags:
      - Workflow Agents
      summary: Add Generation
      description: Add Generation Agent Configuration
      operationId: add_generation_api_v1_agent__agent_id__generation_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentID'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Workflow Agents
      summary: Get Generation
      description: Set Agent Configuration
      operationId: get_generation_api_v1_agent__agent_id__generation_get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items: {}
                title: Response Get Generation Api V1 Agent  Agent Id  Generation
                  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/generation/{generation}:
    patch:
      tags:
      - Workflow Agents
      summary: Patch Generation
      description: Set PreProcess Agent Configuration
      operationId: patch_generation_api_v1_agent__agent_id__generation__generation__patch
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: generation
        in: path
        required: true
        schema:
          type: string
          title: Generation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Workflow Agents
      summary: Delete Generation
      description: Delete Generation Agent Configuration
      operationId: delete_generation_api_v1_agent__agent_id__generation__generation__delete
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: generation
        in: path
        required: true
        schema:
          type: string
          title: Generation
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/import:
    post:
      tags:
      - Import Export
      summary: Import Retrieval Agent
      description: Import Retrieval Agent Configuration
      operationId: import_retrieval_agent_api_v1_agent__agent_id__import_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_import_retrieval_agent_api_v1_agent__agent_id__import_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/postprocess:
    post:
      tags:
      - Workflow Agents
      summary: Add Postprocess
      description: Add PostProcess Agent Configuration
      operationId: add_postprocess_api_v1_agent__agent_id__postprocess_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentID'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Workflow Agents
      summary: Get Postprocess
      description: Set Agent Configuration
      operationId: get_postprocess_api_v1_agent__agent_id__postprocess_get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items: {}
                title: Response Get Postprocess Api V1 Agent  Agent Id  Postprocess
                  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/postprocess/{postprocess}:
    patch:
      tags:
      - Workflow Agents
      summary: Patch Postprocess
      description: Set PostProcess Agent Configuration
      operationId: patch_postprocess_api_v1_agent__agent_id__postprocess__postprocess__patch
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: postprocess
        in: path
        required: true
        schema:
          type: string
          title: Postprocess
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Workflow Agents
      summary: Delete Postprocess
      description: Delete PreProcess Agent Configuration
      operationId: delete_postprocess_api_v1_agent__agent_id__postprocess__postprocess__delete
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: postprocess
        in: path
        required: true
        schema:
          type: string
          title: Postprocess
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/preprocess:
    post:
      tags:
      - Workflow Agents
      summary: Add Preprocess
      description: Add PreProcess Agent Configuration
      operationId: add_preprocess_api_v1_agent__agent_id__preprocess_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentID'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Workflow Agents
      summary: Get Preprocess
      description: Set Agent Configuration
      operationId: get_preprocess_api_v1_agent__agent_id__preprocess_get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items: {}
                title: Response Get Preprocess Api V1 Agent  Agent Id  Preprocess
                  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/preprocess/{preprocess}:
    patch:
      tags:
      - Workflow Agents
      summary: Patch Preprocess
      description: Set PreProcess Agent Configuration
      operationId: patch_preprocess_api_v1_agent__agent_id__preprocess__preprocess__patch
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: preprocess
        in: path
        required: true
        schema:
          type: string
          title: Preprocess
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Workflow Agents
      summary: Delete Preprocess
      description: Delete PreProcess Agent Configuration
      operationId: delete_preprocess_api_v1_agent__agent_id__preprocess__preprocess__delete
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: preprocess
        in: path
        required: true
        schema:
          type: string
          title: Preprocess
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/prompt/{prompt_id}:
    patch:
      tags:
      - Prompt Management
      summary: Patch Prompt
      description: Update Prompt of Agent
      operationId: patch_prompt_api_v1_agent__agent_id__prompt__prompt_id__patch
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: prompt_id
        in: path
        required: true
        schema:
          type: string
          title: Prompt Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromptConfig'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Prompt Management
      summary: Delete Prompt
      description: Delete prompt id
      operationId: delete_prompt_api_v1_agent__agent_id__prompt__prompt_id__delete
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: prompt_id
        in: path
        required: true
        schema:
          type: string
          title: Prompt Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Prompt Management
      summary: Get Prompt
      description: Get Agent Configuration
      operationId: get_prompt_api_v1_agent__agent_id__prompt__prompt_id__get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: prompt_id
        in: path
        required: true
        schema:
          type: string
          title: Prompt Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptConfig'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/prompts:
    post:
      tags:
      - Prompt Management
      summary: Add Prompt
      description: Add Prompt to Agent
      operationId: add_prompt_api_v1_agent__agent_id__prompts_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromptConfig'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptID'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Prompt Management
      summary: Get Prompts
      description: Get Agent Configuration
      operationId: get_prompts_api_v1_agent__agent_id__prompts_get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PromptConfig'
                title: Response Get Prompts Api V1 Agent  Agent Id  Prompts Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/rules:
    post:
      tags:
      - Workflows
      summary: Set Rules
      description: Set Agent Configuration
      operationId: set_rules_api_v1_agent__agent_id__rules_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Rules'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Workflows
      summary: Get Rules
      description: Set Agent Configuration
      operationId: get_rules_api_v1_agent__agent_id__rules_get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/session/{session}:
    post:
      tags:
      - Sessions
      summary: Interaction
      description: Interact session
      operationId: interaction_api_v1_agent__agent_id__session__session__post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: session
        in: path
        required: true
        schema:
          type: string
          title: Session
      - name: workflow_id
        in: query
        required: false
        schema:
          type: string
          default: default
          title: Workflow Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InteractionRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Sessions
      summary: Patch Session
      description: Create session
      operationId: patch_session_api_v1_agent__agent_id__session__session__patch
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: session
        in: path
        required: true
        schema:
          type: string
          title: Session
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionData'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Sessions
      summary: Delete Session
      description: Delete session
      operationId: delete_session_api_v1_agent__agent_id__session__session__delete
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: session
        in: path
        required: true
        schema:
          type: string
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Sessions
      summary: Get Session
      description: Create session
      operationId: get_session_api_v1_agent__agent_id__session__session__get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: session
        in: path
        required: true
        schema:
          type: string
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/session/{session}/mcp:
    delete:
      tags:
      - MCP
      summary: Mcp Handler Delete
      operationId: mcp_handler_delete_api_v1_agent__agent_id__session__session__mcp_delete
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: session
        in: path
        required: true
        schema:
          type: string
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - MCP
      summary: Interaction Mcp Handler
      operationId: interaction_mcp_handler_api_v1_agent__agent_id__session__session__mcp_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: session
        in: path
        required: true
        schema:
          type: string
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - MCP
      summary: Interaction Mcp Handler
      operationId: interaction_mcp_handler_api_v1_agent__agent_id__session__session__mcp_get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: session
        in: path
        required: true
        schema:
          type: string
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/sessions:
    post:
      tags:
      - Sessions
      summary: Create Session
      description: Create session
      operationId: create_session_api_v1_agent__agent_id__sessions_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionData'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCreated'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Sessions
      summary: Get Sessions
      description: Create session
      operationId: get_sessions_api_v1_agent__agent_id__sessions_get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: page
        in: query
        required: false
        schema:
          type: integer
          description: Requested page number (0-based)
          default: 0
          title: Page
        description: Requested page number (0-based)
      - name: size
        in: query
        required: false
        schema:
          type: integer
          description: Page size
          default: 20
          title: Size
        description: Page size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/workflow/{workflow_id}:
    patch:
      tags:
      - Workflows
      summary: Set Workflow
      description: Set Workflow Configuration
      operationId: set_workflow_api_v1_agent__agent_id__workflow__workflow_id__patch
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Workflows
      summary: Delete Workflow
      description: Delete Workflow Configuration
      operationId: delete_workflow_api_v1_agent__agent_id__workflow__workflow_id__delete
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/workflow/{workflow_id}/generation:
    post:
      tags:
      - Workflow Agents
      summary: Add Generation
      description: Add Generation Workflows Configuration
      operationId: add_generation_api_v1_agent__agent_id__workflow__workflow_id__generation_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentID'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Workflow Agents
      summary: Get Generation
      description: Get Generation Workflows Configuration
      operationId: get_generation_api_v1_agent__agent_id__workflow__workflow_id__generation_get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items: {}
                title: Response Get Generation Api V1 Agent  Agent Id  Workflow  Workflow
                  Id  Generation Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/workflow/{workflow_id}/generation/{generation}:
    patch:
      tags:
      - Workflow Agents
      summary: Patch Generation
      description: Set Generation Workflows Configuration
      operationId: patch_generation_api_v1_agent__agent_id__workflow__workflow_id__generation__generation__patch
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      - name: generation
        in: path
        required: true
        schema:
          type: string
          title: Generation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Workflow Agents
      summary: Delete Generation
      description: Delete Generation Workflows Configuration
      operationId: delete_generation_api_v1_agent__agent_id__workflow__workflow_id__generation__generation__delete
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      - name: generation
        in: path
        required: true
        schema:
          type: string
          title: Generation
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/workflow/{workflow_id}/postprocess:
    post:
      tags:
      - Workflow Agents
      summary: Add Postprocess
      description: Add PostProcess Workflows Configuration
      operationId: add_postprocess_api_v1_agent__agent_id__workflow__workflow_id__postprocess_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentID'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Workflow Agents
      summary: Get Postprocess
      description: Get PostProcess Workflows Configuration
      operationId: get_postprocess_api_v1_agent__agent_id__workflow__workflow_id__postprocess_get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items: {}
                title: Response Get Postprocess Api V1 Agent  Agent Id  Workflow  Workflow
                  Id  Postprocess Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/workflow/{workflow_id}/postprocess/{postprocess}:
    patch:
      tags:
      - Workflow Agents
      summary: Patch Postprocess
      description: Set PostProcess Workflows Configuration
      operationId: patch_postprocess_api_v1_agent__agent_id__workflow__workflow_id__postprocess__postprocess__patch
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      - name: postprocess
        in: path
        required: true
        schema:
          type: string
          title: Postprocess
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Workflow Agents
      summary: Delete Postprocess
      description: Delete PostProcess Workflows Configuration
      operationId: delete_postprocess_api_v1_agent__agent_id__workflow__workflow_id__postprocess__postprocess__delete
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      - name: postprocess
        in: path
        required: true
        schema:
          type: string
          title: Postprocess
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/workflow/{workflow_id}/preprocess:
    post:
      tags:
      - Workflow Agents
      summary: Add Preprocess
      description: Add PreProcess Workflows Configuration
      operationId: add_preprocess_api_v1_agent__agent_id__workflow__workflow_id__preprocess_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentID'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Workflow Agents
      summary: Get Preprocess
      description: Set Workflow Configuration
      operationId: get_preprocess_api_v1_agent__agent_id__workflow__workflow_id__preprocess_get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items: {}
                title: Response Get Preprocess Api V1 Agent  Agent Id  Workflow  Workflow
                  Id  Preprocess Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/workflow/{workflow_id}/preprocess/{preprocess}:
    patch:
      tags:
      - Workflow Agents
      summary: Patch Preprocess
      description: Set PreProcess Workflows Configuration
      operationId: patch_preprocess_api_v1_agent__agent_id__workflow__workflow_id__preprocess__preprocess__patch
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      - name: preprocess
        in: path
        required: true
        schema:
          type: string
          title: Preprocess
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Workflow Agents
      summary: Delete Preprocess
      description: Delete PreProcess Workflows Configuration
      operationId: delete_preprocess_api_v1_agent__agent_id__workflow__workflow_id__preprocess__preprocess__delete
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: preprocess
        in: path
        required: true
        schema:
          type: string
          title: Preprocess
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/workflow/{workflow_id}/rules:
    post:
      tags:
      - Workflows
      summary: Set Rules
      description: Set Workflow Rules Configuration
      operationId: set_rules_api_v1_agent__agent_id__workflow__workflow_id__rules_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Rules'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Workflows
      summary: Get Rules
      description: Get Workflow Rules Configuration
      operationId: get_rules_api_v1_agent__agent_id__workflow__workflow_id__rules_get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/workflow/{workflow_id}/session/{session}:
    post:
      tags:
      - Sessions
      summary: Interaction
      description: Interact session
      operationId: interaction_api_v1_agent__agent_id__workflow__workflow_id__session__session__post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - name: session
        in: path
        required: true
        schema:
          type: string
          title: Session
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
          title: Workflow Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InteractionRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /agent/{agent_id}/workflows:
    post:
      tags:
      - Workflows
      summary: Add Workflow
      description: Add Workflow Configuration
      operationId: add_workflow_api_v1_agent__agent_id__workflows_post
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowInput'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Workflows
      summary: Get Workflows
      description: Get Workflow Configuration
      operationId: get_workflows_api_v1_agent__agent_id__workflows_get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorkflowData'
                title: Response Get Workflows Api V1 Agent  Agent Id  Workflows Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
x-metadata:
  hyperforge:
    commit: 9fff4c2
    last_updated: '2026-08-24T12:53:31.156857+00:00'
components:
  schemas:
    AgentID:
      properties:
        id:
          type: string
          title: Id
      type: object
      required:
      - id
      title: AgentID
    Answer:
      properties:
        text:
          type: string
          title: Text
        language:
          anyOf:
          - type: string
          - type: 'null'
          title: Language
        ids_paragraphs:
          items:
            type: string
          type: array
          title: Ids Paragraphs
      type: object
      required:
      - text
      - ids_paragraphs
      title: Answer
    BaseModel:
      properties: {}
      type: object
      title: BaseModel
    Body_import_retrieval_agent_api_v1_agent__agent_id__import_post:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
        passphrase:
          type: string
          title: Passphrase
          description: Passphrase for the encrypted export file
        overwrite:
          type: boolean
          title: Overwrite
          description: Whether to overwrite existing agent configuration. If false
            and the agent configuration is not empty, the import will fail.
          default: false
      type: object
      required:
      - file
      - passphrase
      title: Body_import_retrieval_agent_api_v1_agent__agent_id__import_post
    Classification:
      properties:
        labelset:
          type: string
          title: The ID of the labelset
        label:
          type: string
          title: The label assigned from the labelset
      type: object
      required:
      - labelset
      - label
      title: Classification
    CloudLink:
      properties:
        uri:
          anyOf:
          - type: string
          - type: 'null'
          title: Uri
        size:
          anyOf:
          - type: integer
          - type: 'null'
          title: Size
        content_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Content Type
        filename:
          anyOf:
          - type: string
          - type: 'null'
          title: Filename
        md5:
          anyOf:
          - type: string
          - type: 'null'
          title: Md5
      type: object
      title: CloudLink
    ComputedMetadata:
      properties:
        field_classifications:
          items:
            $ref: '#/components/schemas/FieldClassification'
          type: array
          title: Field Classifications
          default: []
      type: object
      title: ComputedMetadata
      description: 'The purpose of this field is to show a cherry-picked set of fields
        from computed metadata

        without having to load the whole computed metadata field.'
    ConversationFieldData:
      properties:
        value:
          anyOf:
          - $ref: '#/components/schemas/FieldConversation'
          - type: 'null'
        extracted:
          anyOf:
          - $ref: '#/components/schemas/ConversationFieldExtractedData'
          - type: 'null'
        error:
          anyOf:
          - $ref: '#/components/schemas/Error'
          - type: 'null'
        status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        errors:
          anyOf:
          - items:
              $ref: '#/components/schemas/Error'
            type: array
          - type: 'null'
          title: Errors
      type: object
      title: ConversationFieldData
    ConversationFieldExtractedData:
      properties:
        text:
          anyOf:
          - $ref: '#/components/schemas/ExtractedText'
          - type: 'null'
        metadata:
          anyOf:
          - $ref: '#/components/schemas/FieldComputedMetadata'
          - type: 'null'
        large_metadata:
          anyOf:
          - $ref: '#/components/schemas/LargeComputedMetadata'
          - type: 'null'
        vectors:
          anyOf:
          - $ref: '#/components/schemas/VectorObject'
          - type: 'null'
        question_answers:
          anyOf:
          - $ref: '#/components/schemas/FieldQuestionAnswers'
          - type: 'null'
        relation_node_vectors:
          anyOf:
          - additionalProperties:
              items:
                $ref: '#/components/schemas/RelationNodeVector'
              type: array
            type: object
          - type: 'null'
          title: Relation Node Vectors
        relation_edge_vectors:
          anyOf:
          - additionalProperties:
              items:
                $ref: '#/components/schemas/RelationEdgeVector'
              type: array
            type: object
          - type: 'null'
          title: Relation Edge Vectors
      type: object
      title: ConversationFieldExtractedData
    DownloadStatus:
      properties:
        id:
          type: string
          title: Id
        type:
          type: string
          title: Type
        status:
          type: string
          enum:
          - pending
          - ready
          title: Status
        download_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Download Url
        query:
          additionalProperties: true
          type: object
          title: Query
      type: object
      required:
      - id
      - type
      - status
      - download_url
      - query
      title: DownloadStatus
    DriverConfig:
      properties:
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
        identifier:
          type: string
          title: Identifier
        name:
          type: string
          title: Name
        provider:
          title: Provider
          description: The type of source, e.g., 'google', 'marklogic', etc.
        config:
          $ref: '#/components/schemas/EncryptedPayload'
          description: The configuration specific to the source.
      type: object
      required:
      - identifier
      - name
      - provider
      - config
      title: DriverConfig
    DriverID:
      properties:
        id:
          type: string
          title: Id
      type: object
      required:
      - id
      title: DriverID
    EncryptedPayload:
      properties: {}
      type: object
      title: EncryptedPayload
    Entity:
      properties:
        token:
          anyOf:
          - type: string
          - type: 'null'
          title: Token
        root:
          anyOf:
          - type: string
          - type: 'null'
          title: Root
        type:
          anyOf:
          - type: string
          - type: 'null'
          title: Type
      type: object
      title: Entity
    Error:
      properties:
        body:
          type: string
          title: Body
        code:
          type: integer
          title: Code
        code_str:
          type: string
          title: Code Str
        created:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created
        severity:
          type: string
          title: Severity
      type: object
      required:
      - body
      - code
      - code_str
      - created
      - severity
      title: Error
    Extra:
      properties:
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
          description: Arbitrary JSON metadata provided by the user that is not meant
            to be searchable, but can be serialized on results.
      type: object
      required:
      - metadata
      title: Extra
    ExtractedText:
      properties:
        text:
          anyOf:
          - type: string
          - type: 'null'
          title: Text
        split_text:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Split Text
        deleted_splits:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Deleted Splits
      type: object
      title: ExtractedText
    FieldClassification:
      properties:
        field:
          $ref: '#/components/schemas/FieldID'
        classifications:
          items:
            $ref: '#/components/schemas/Classification'
          type: array
          title: Classifications
          default: []
      type: object
      required:
      - field
      title: FieldClassification
    FieldComputedMetadata:
      properties:
        metadata:
          $ref: '#/components/schemas/FieldMetadata'
        split_metadata:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/FieldMetadata'
            type: object
          - type: 'null'
          title: Split Metadata
        deleted_splits:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Deleted Splits
      type: object
      required:
      - metadata
      title: FieldComputedMetadata
    FieldConversation:
      properties:
        pages:
          anyOf:
          - type: integer
          - type: 'null'
          title: Pages
        size:
          anyOf:
          - type: integer
          - type: 'null'
          title: Size
        total:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total
        extract_strategy:
          anyOf:
          - type: string
          - type: 'null'
          title: Extract Strategy
        split_strategy:
          anyOf:
          - type: string
          - type: 'null'
          title: Split Strategy
      type: object
      title: FieldConversation
      description: 'This is a metadata representation of a conversation about how
        many pages

        of messages and total of messages we have.


        This class is used mainly when exposing a conversation in the resource level'
    FieldEntities:
      properties:
        entities:
          items:
            $ref: '#/components/schemas/FieldEntity'
          type: array
          title: Entities
      type: object
      required:
      - entities
      title: FieldEntities
      description: Wrapper for the entities extracted from a field (required because
        protobuf doesn't support lists of lists)
    FieldEntity:
      properties:
        text:
          type: string
          title: Text
        label:
          type: string
          title: Label
        positions:
          items:
            $ref: '#/components/schemas/Position'
          type: array
          title: Positions
      type: object
      required:
      - text
      - label
      - positions
      title: FieldEntity
    FieldFile:
      properties:
        added:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Added
        file:
          anyOf:
          - $ref: '#/components/schemas/CloudLink'
          - type: 'null'
        language:
          anyOf:
          - type: string
          - type: 'null'
          title: Language
        password:
          anyOf:
          - type: string
          - type: 'null'
          title: Password
        external:
          type: boolean
          title: External
          default: false
        extract_strategy:
          anyOf:
          - type: string
          - type: 'null'
          title: Extract Strategy
          description: Id of the Nuclia extract strategy used at processing time.
            If not set, the default strategy was used. Extract strategies are defined
            at the learning configuration api.
        split_strategy:
          anyOf:
          - type: string
          - type: 'null'
          title: Split Strategy
          description: Id of the Nuclia split strategy used at processing time. If
            not set, the default strategy was used. Split strategies are defined at
            the learning configuration api.
      type: object
      title: FieldFile
    FieldID:
      properties:
        field_type:
          $ref: '#/components/schemas/FieldType'
        field:
          type: string
          title: Field
      type: object
      required:
      - field_type
      - field
      title: FieldID
    FieldLargeMetadata:
      properties:
        entities:
          anyOf:
          - items:
              $ref: '#/components/schemas/Entity'
            type: array
          - type: 'null'
          title: Entities
        tokens:
          anyOf:
          - additionalProperties:
              type: integer
            type: object
          - type: 'null'
          title: Tokens
      type: object
      title: FieldLargeMetadata
    FieldLink:
      properties:
        added:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Added
        headers:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Headers
        cookies:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Cookies
        uri:
          anyOf:
          - type: string
          - type: 'null'
          title: Uri
        language:
          anyOf:
          - type: string
          - type: 'null'
          title: Language
        localstorage:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Localstorage
        css_selector:
          anyOf:
          - type: string
          - type: 'null'
          title: Css Selector
        xpath:
          anyOf:
          - type: string
          - type: 'null'
          title: Xpath
        extract_strategy:
          anyOf:
          - type: string
          - type: 'null'
          title: Extract Strategy
          description: Id of the Nuclia extract strategy used at processing time.
            If not set, the default strategy was used. Extract strategies are defined
            at the learning configuration api.
        split_strategy:
          anyOf:
          - type: string
          - type: 'null'
          title: Split Strategy
          description: Id of the Nuclia split strategy used at processing time. If
            not set, the default strategy was used. Split strategies are defined at
            the learning configuration api.
      type: object
      title: FieldLink
    FieldMetadata:
      properties:
        links:
          items:
            type: string
          type: array
          title: Links
        paragraphs:
          items:
            $ref: '#/components/schemas/Paragraph'
          type: array
          title: Paragraphs
        ner:
          additionalProperties:
            type: string
          type: object
          title: Ner
        entities:
          additionalProperties:
            $ref: '#/components/schemas/FieldEntities'
          type: object
          title: Entities
        classifications:
          items:
            $ref: '#/components/schemas/Classification'
          type: array
          title: Classifications
        last_index:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Index
        last_understanding:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Understanding
        last_extract:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Extract
        last_summary:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Summary
        last_processing_start:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Processing Start
        thumbnail:
          anyOf:
          - $ref: '#/components/schemas/CloudLink'
          - type: 'null'
        language:
          anyOf:
          - type: string
          - type: 'null'
          title: Language
        summary:
          anyOf:
          - type: string
          - type: 'null'
          title: Summary
        positions:
          additionalProperties:
            $ref: '#/components/schemas/Positions'
          type: object
          title: Positions
        relations:
          anyOf:
          - items:
              $ref: '#/components/schemas/Relation'
            type: array
          - type: 'null'
          title: Relations
        mime_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Mime Type
      type: object
      required:
      - links
      - paragraphs
      - ner
      - entities
      - classifications
      - positions
      title: FieldMetadata
    FieldQuestionAnswers:
      properties:
        question_answers:
          $ref: '#/components/schemas/QuestionAnswers'
        split_question_answers:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/QuestionAnswers'
            type: object
          - type: 'null'
          title: Split Question Answers
        deleted_splits:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Deleted Splits
      type: object
      required:
      - question_answers
      title: FieldQuestionAnswers
    FieldText:
      properties:
        body:
          anyOf:
          - type: string
          - type: 'null'
          title: Body
        format:
          anyOf:
          - $ref: '#/components/schemas/TextFormat'
          - type: 'null'
        md5:
          anyOf:
          - type: string
          - type: 'null'
          title: Md5
        extract_strategy:
          anyOf:
          - type: string
          - type: 'null'
          title: Extract Strategy
          description: Id of the Nuclia extract strategy used at processing time.
            If not set, the default strategy was used. Extract strategies are defined
            at the learning configuration api.
        split_strategy:
          anyOf:
          - type: string
          - type: 'null'
          title: Split Strategy
          description: Id of the Nuclia split strategy used at processing time. If
            not set, the default strategy was used. Split strategies are defined at
            the learning configuration api.
      type: object
      title: FieldText
    FieldType:
      type: string
      enum:
      - file
      - link
      - text
      - generic
      - conversation
      title: FieldType
    FileExtractedData:
      properties:
        language:
          anyOf:
          - type: string
          - type: 'null'
          title: Language
        md5:
          anyOf:
          - type: string
          - type: 'null'
          title: Md5
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Metadata
        nested:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Nested
        file_generated:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/CloudLink'
            type: object
          - type: 'null'
          title: File Generated
        file_rows_previews:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/RowsPreview'
            type: object
          - type: 'null'
          title: File Rows Previews
        file_preview:
          anyOf:
          - $ref: '#/components/schemas/CloudLink'
          - type: 'null'
        file_pages_previews:
          anyOf:
          - $ref: '#/components/schemas/FilePages'
          - type: 'null'
        file_thumbnail:
          anyOf:
          - $ref: '#/components/schemas/CloudLink'
          - type: 'null'
        field:
          anyOf:
          - type: string
          - type: 'null'
          title: Field
        icon:
          anyOf:
          - type: string
          - type: 'null'
          title: Icon
        nested_position:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/NestedPosition'
            type: object
          - type: 'null'
          title: Nested Position
        nested_list_position:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/NestedListPosition'
            type: object
          - type: 'null'
          title: Nested List Position
      type: object
      title: FileExtractedData
    FileFieldData:
      properties:
        value:
          anyOf:
          - $ref: '#/components/schemas/FieldFile'
          - type: 'null'
        extracted:
          anyOf:
          - $ref: '#/components/schemas/FileFieldExtractedData'
          - type: 'null'
        error:
          anyOf:
          - $ref: '#/components/schemas/Error'
          - type: 'null'
        status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        errors:
          anyOf:
          - items:
              $ref: '#/components/schemas/Error'
            type: array
          - type: 'null'
          title: Errors
      type: object
      title: FileFieldData
    FileFieldExtractedData:
      properties:
        text:
          anyOf:
          - $ref: '#/components/schemas/ExtractedText'
          - type: 'null'
        metadata:
          anyOf:
          - $ref: '#/components/schemas/FieldComputedMetadata'
          - type: 'null'
        large_metadata:
          anyOf:
          - $ref: '#/components/schemas/LargeComputedMetadata'
          - type: 'null'
        vectors:
          anyOf:
          - $ref: '#/components/schemas/VectorObject'
          - type: 'null'
        question_answers:
          anyOf:
          - $ref: '#/components/schemas/FieldQuestionAnswers'
          - type: 'null'
        relation_node_vectors:
          anyOf:
          - additionalProperties:
              items:
                $ref: '#/components/schemas/RelationNodeVector'
              type: array
            type: object
          - type: 'null'
          title: Relation Node Vectors
        relation_edge_vectors:
          anyOf:
          - additionalProperties:
              items:
                $ref: '#/components/schemas/RelationEdgeVector'
              type: array
            type: object
          - type: 'null'
          title: Relation Edge Vectors
        file:
          anyOf:
          - $ref: '#/components/schemas/FileExtractedData'
          - type: 'null'
      type: object
      title: FileFieldExtractedData
    FilePages:
      properties:
        pages:
          anyOf:
          - items:
              $ref: '#/components/schemas/CloudLink'
            type: array
          - type: 'null'
          title: Pages
        positions:
          anyOf:
          - items:
              $ref: '#/components/schemas/PagePositions'
            type: array
          - type: 'null'
          title: Positions
        structures:
          anyOf:
          - items:
              $ref: '#/components/schemas/PageStructure'
            type: array
          - type: 'null'
          title: Structures
      type: object
      title: FilePages
    GenericFieldData:
      properties:
        value:
          anyOf:
          - type: string
          - type: 'null'
          title: Value
        extracted:
          anyOf:
          - $ref: '#/components/schemas/TextFieldExtractedData'
          - type: 'null'
        error:
          anyOf:
          - $ref: '#/components/schemas/Error'
          - type: 'null'
        status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        errors:
          anyOf:
          - items:
              $ref: '#/components/schemas/Error'
            type: array
          - type: 'null'
          title: Errors
      type: object
      title: GenericFieldData
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    HistoryQuestionAnswer:
      properties:
        question:
          type: string
          title: Question
        answer:
          type: string
          title: Answer
      type: object
      required:
      - question
      - answer
      title: HistoryQuestionAnswer
    InteractionOperation:
      type: integer
      enum:
      - 0
      - 1
      title: InteractionOperation
    InteractionRequest:
      properties:
        question:
          type: string
          title: Question
        headers:
          additionalProperties:
            type: string
          type: object
          title: Headers
          default: {}
        arguments:
          additionalProperties:
            type: string
          type: object
          title: Arguments
          default: {}
        chat_history:
          anyOf:
          - items:
              $ref: '#/components/schemas/HistoryQuestionAnswer'
            type: array
          - type: 'null'
          title: Chat History
          description: Client-managed chat history. When set (even to an empty list),
            overrides any server-side session history for agents that use previous
            Q&A context (rephrase, summarize, smart, etc.). Omit the field entirely
            to use server-side session history.
        operation:
          $ref: '#/components/schemas/InteractionOperation'
          default: 0
        streaming:
          type: boolean
          title: Streaming
          default: false
      type: object
      required:
      - question
      title: InteractionRequest
    InteractionsAuditDownloadRequest:
      properties:
        session_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Session Id
          description: Filter by session ID
        year:
          anyOf:
          - type: integer
          - type: 'null'
          title: Year
          description: Filter by year (e.g., 2024). If not specified, defaults to
            the current year.
        month:
          anyOf:
          - type: integer
          - type: 'null'
          title: Month
          description: Filter by month (1-12). If not specified, defaults to the past
            month.
      type: object
      title: InteractionsAuditDownloadRequest
    KeyValueField:
      properties:
        data:
          additionalProperties:
            anyOf:
            - type: string
            - items:
                type: string
              type: array
            - type: integer
            - type: number
            - type: boolean
            - type: string
              format: date-time
            - $ref: '#/components/schemas/Range'
          type: object
          title: Data
          description: Key-value pairs conforming to the schema.
      type: object
      title: KeyValueField
      description: "A key-value field value. The field id (key in the resource's key_values\
        \ dict)\nmust equal the schema name \u2014 enforcing one KV field per schema\
        \ per resource."
    KeyValueFieldData:
      properties:
        value:
          anyOf:
          - $ref: '#/components/schemas/KeyValueField'
          - type: 'null'
        error:
          anyOf:
          - $ref: '#/components/schemas/Error'
          - type: 'null'
        status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        errors:
          anyOf:
          - items:
              $ref: '#/components/schemas/Error'
            type: array
          - type: 'null'
          title: Errors
      type: object
      title: KeyValueFieldData
    LargeComputedMetadata:
      properties:
        metadata:
          anyOf:
          - $ref: '#/components/schemas/FieldLargeMetadata'
          - type: 'null'
        split_metadata:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/FieldLargeMetadata'
            type: object
          - type: 'null'
          title: Split Metadata
        deleted_splits:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Deleted Splits
      type: object
      title: LargeComputedMetadata
    LinkExtractedData:
      properties:
        date:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Date
        language:
          anyOf:
          - type: string
          - type: 'null'
          title: Language
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Metadata
        link_thumbnail:
          anyOf:
          - $ref: '#/components/schemas/CloudLink'
          - type: 'null'
        link_preview:
          anyOf:
          - $ref: '#/components/schemas/CloudLink'
          - type: 'null'
        field:
          anyOf:
          - type: string
          - type: 'null'
          title: Link Extracted Data Field
        link_image:
          anyOf:
          - $ref: '#/components/schemas/CloudLink'
          - type: 'null'
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        type:
          anyOf:
          - type: string
          - type: 'null'
          title: Type
        embed:
          anyOf:
          - type: string
          - type: 'null'
          title: Embed
        file_generated:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/CloudLink'
            type: object
          - type: 'null'
          title: File Generated
      type: object
      title: LinkExtractedData
    LinkFieldData:
      properties:
        value:
          anyOf:
          - $ref: '#/components/schemas/FieldLink'
          - type: 'null'
        extracted:
          anyOf:
          - $ref: '#/components/schemas/LinkFieldExtractedData'
          - type: 'null'
        error:
          anyOf:
          - $ref: '#/components/schemas/Error'
          - type: 'null'
        status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        errors:
          anyOf:
          - items:
              $ref: '#/components/schemas/Error'
            type: array
          - type: 'null'
          title: Errors
      type: object
      title: LinkFieldData
    LinkFieldExtractedData:
      properties:
        text:
          anyOf:
          - $ref: '#/components/schemas/ExtractedText'
          - type: 'null'
        metadata:
          anyOf:
          - $ref: '#/components/schemas/FieldComputedMetadata'
          - type: 'null'
        large_metadata:
          anyOf:
          - $ref: '#/components/schemas/LargeComputedMetadata'
          - type: 'null'
        vectors:
          anyOf:
          - $ref: '#/components/schemas/VectorObject'
          - type: 'null'
        question_answers:
          anyOf:
          - $ref: '#/components/schemas/FieldQuestionAnswers'
          - type: 'null'
        relation_node_vectors:
          anyOf:
          - additionalProperties:
              items:
                $ref: '#/components/schemas/RelationNodeVector'
              type: array
            type: object
          - type: 'null'
          title: Relation Node Vectors
        relation_edge_vectors:
          anyOf:
          - additionalProperties:
              items:
                $ref: '#/components/schemas/RelationEdgeVector'
              type: array
            type: object
          - type: 'null'
          title: Relation Edge Vectors
        link:
          anyOf:
          - $ref: '#/components/schemas/LinkExtractedData'
          - type: 'null'
      type: object
      title: LinkFieldExtractedData
    Metadata:
      properties:
        metadata:
          additionalProperties:
            type: string
          type: object
          title: Metadata
          default: {}
        language:
          anyOf:
          - type: string
          - type: 'null'
          title: Language
        languages:
          anyOf:
          - items:
              type: string
            type: array
            maxItems: 1024
          - type: 'null'
          title: Languages
        status:
          $ref: '#/components/schemas/ResourceProcessingStatus'
      type: object
      required:
      - status
      title: Metadata
    NestedListPosition:
      properties:
        positions:
          items:
            $ref: '#/components/schemas/NestedPosition'
          type: array
          title: Positions
      type: object
      required:
      - positions
      title: NestedListPosition
    NestedPosition:
      properties:
        start:
          anyOf:
          - type: integer
          - type: 'null'
          title: Start
        end:
          anyOf:
          - type: integer
          - type: 'null'
          title: End
        page:
          anyOf:
          - type: integer
          - type: 'null'
          title: Position Page
      type: object
      title: NestedPosition
    Origin:
      properties:
        source_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Id
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
        created:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created
        modified:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Modified
        metadata:
          additionalProperties:
            type: string
          type: object
          title: Metadata
          description: Generic metadata from the resource at the origin system. It
            can later be used for filtering on search endpoints with '/origin.metadata/{key}/{value}'
          default: {}
        tags:
          items:
            type: string
          type: array
          title: Tags
          description: Resource tags about the origin system. It can later be used
            for filtering on search endpoints with '/origin.tags/{tag}'
          default: []
        collaborators:
          items:
            type: string
          type: array
          maxItems: 100
          title: Collaborators
          default: []
        filename:
          anyOf:
          - type: string
          - type: 'null'
          title: Filename
        related:
          items:
            type: string
          type: array
          maxItems: 100
          title: Related
          default: []
        path:
          anyOf:
          - type: string
            maxLength: 2048
          - type: 'null'
          title: Path
          description: Path of the original resource. Typically used to store folder
            structure information of the resource at the origin system. It can be
            later used for filtering on search endpoints with '/origin.path/{path}'
        sync_metadata:
          anyOf:
          - $ref: '#/components/schemas/SyncMetadata'
          - type: 'null'
          title: Sync Metadata
          description: Metadata related to the resource from the origin system fetched
            by the Progress Agentic RAG's Cloud Storage Sync service.
        source:
          anyOf:
          - $ref: '#/components/schemas/Source'
          - type: 'null'
          default: API
      type: object
      title: Origin
    PageInformation:
      properties:
        page:
          anyOf:
          - type: integer
          - type: 'null'
          title: Page Information Page
        page_with_visual:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Page With Visual
      type: object
      title: PageInformation
    PagePositions:
      properties:
        start:
          anyOf:
          - type: integer
          - type: 'null'
          title: Start
        end:
          anyOf:
          - type: integer
          - type: 'null'
          title: End
      type: object
      title: PagePositions
    PageStructure:
      properties:
        page:
          $ref: '#/components/schemas/PageStructurePage'
        tokens:
          items:
            $ref: '#/components/schemas/PageStructureToken'
          type: array
          title: Tokens
      type: object
      required:
      - page
      - tokens
      title: PageStructure
    PageStructurePage:
      properties:
        width:
          type: integer
          title: Width
        height:
          type: integer
          title: Height
      type: object
      required:
      - width
      - height
      title: PageStructurePage
    PageStructureToken:
      properties:
        x:
          type: number
          title: X
        y:
          type: number
          title: Y
        width:
          type: number
          title: Width
        height:
          type: number
          title: Height
        text:
          type: string
          title: Text
        line:
          type: number
          title: Line
      type: object
      required:
      - x
      - y
      - width
      - height
      - text
      - line
      title: PageStructureToken
    Paragraph:
      properties:
        start:
          anyOf:
          - type: integer
          - type: 'null'
          title: Start
        end:
          anyOf:
          - type: integer
          - type: 'null'
          title: End
        start_seconds:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Start Seconds
        end_seconds:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: End Seconds
        kind:
          anyOf:
          - $ref: '#/components/schemas/TypeParagraph'
          - type: 'null'
        classifications:
          anyOf:
          - items:
              $ref: '#/components/schemas/Classification'
            type: array
          - type: 'null'
          title: Classifications
        sentences:
          anyOf:
          - items:
              $ref: '#/components/schemas/Sentence'
            type: array
          - type: 'null'
          title: Sentences
        key:
          anyOf:
          - type: string
          - type: 'null'
          title: Key
        page:
          anyOf:
          - $ref: '#/components/schemas/PageInformation'
          - type: 'null'
        representation:
          anyOf:
          - $ref: '#/components/schemas/Representation'
          - type: 'null'
        relations:
          anyOf:
          - $ref: '#/components/schemas/ParagraphRelations'
          - type: 'null'
      type: object
      title: Paragraph
    ParagraphAnnotation:
      properties:
        classifications:
          items:
            $ref: '#/components/schemas/UserClassification'
          type: array
          title: Classifications
          default: []
        key:
          type: string
          title: Key
      type: object
      required:
      - key
      title: ParagraphAnnotation
    ParagraphRelations:
      properties:
        parents:
          items:
            type: string
          type: array
          title: Parents
          default: []
        siblings:
          items:
            type: string
          type: array
          title: Siblings
          default: []
        replacements:
          items:
            type: string
          type: array
          title: Replacements
          default: []
      type: object
      title: ParagraphRelations
    Position:
      properties:
        start:
          type: integer
          title: Start
        end:
          type: integer
          title: End
      type: object
      required:
      - start
      - end
      title: Position
    Positions:
      properties:
        position:
          items:
            $ref: '#/components/schemas/Position'
          type: array
          title: Position
        entity:
          type: string
          title: Entity
      type: object
      required:
      - position
      - entity
      title: Positions
    PromptArgument:
      properties:
        name:
          type: string
          title: Name
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        required:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Required
      type: object
      required:
      - name
      title: PromptArgument
      description: An argument for a prompt template.
    PromptConfig:
      properties:
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        prompt:
          type: string
          title: Prompt
        arguments:
          anyOf:
          - items:
              $ref: '#/components/schemas/PromptArgument'
            type: array
          - type: 'null'
          title: Arguments
        icons:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Icons
        meta:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Meta
        prompt_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Prompt Id
      type: object
      required:
      - name
      - description
      - prompt
      title: PromptConfig
    PromptID:
      properties:
        id:
          type: string
          title: Id
      type: object
      required:
      - id
      title: PromptID
    Question:
      properties:
        text:
          type: string
          title: Text
        language:
          anyOf:
          - type: string
          - type: 'null'
          title: Language
        ids_paragraphs:
          items:
            type: string
          type: array
          title: Ids Paragraphs
      type: object
      required:
      - text
      - ids_paragraphs
      title: Question
    QuestionAnswer:
      properties:
        question:
          $ref: '#/components/schemas/Question'
        answers:
          items:
            $ref: '#/components/schemas/Answer'
          type: array
          title: Answers
      type: object
      required:
      - question
      - answers
      title: QuestionAnswer
    QuestionAnswerAnnotation:
      properties:
        question_answer:
          $ref: '#/components/schemas/QuestionAnswer'
        cancelled_by_user:
          type: boolean
          title: Cancelled By User
          default: false
      type: object
      required:
      - question_answer
      title: QuestionAnswerAnnotation
    QuestionAnswers:
      properties:
        question_answer:
          items:
            $ref: '#/components/schemas/QuestionAnswer'
          type: array
          title: Question Answer
      type: object
      required:
      - question_answer
      title: QuestionAnswers
    QueueType:
      type: string
      enum:
      - private
      - shared
      title: QueueType
    Range:
      additionalProperties: true
      type: object
    Relation:
      properties:
        relation:
          $ref: '#/components/schemas/RelationType'
        label:
          anyOf:
          - type: string
          - type: 'null'
          title: Label
        metadata:
          anyOf:
          - $ref: '#/components/schemas/RelationMetadata'
          - type: 'null'
        from:
          anyOf:
          - $ref: '#/components/schemas/RelationEntity'
          - type: 'null'
        to:
          $ref: '#/components/schemas/RelationEntity'
      type: object
      required:
      - relation
      - to
      title: Relation
    RelationEdgeVector:
      properties:
        relation_label:
          type: string
          title: Relation Label
        vector:
          items:
            type: number
          type: array
          title: Vector
      type: object
      required:
      - relation_label
      - vector
      title: RelationEdgeVector
    RelationEntity:
      properties:
        value:
          type: string
          title: Value
        type:
          $ref: '#/components/schemas/RelationNodeType'
        group:
          anyOf:
          - type: string
          - type: 'null'
          title: Group
      type: object
      required:
      - value
      - type
      title: RelationEntity
    RelationMetadata:
      properties:
        paragraph_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Paragraph Id
        source_start:
          anyOf:
          - type: integer
          - type: 'null'
          title: Source Start
        source_end:
          anyOf:
          - type: integer
          - type: 'null'
          title: Source End
        to_start:
          anyOf:
          - type: integer
          - type: 'null'
          title: To Start
        to_end:
          anyOf:
          - type: integer
          - type: 'null'
          title: To End
        data_augmentation_task_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Data Augmentation Task Id
      type: object
      title: RelationMetadata
    RelationNodeType:
      type: string
      enum:
      - entity
      - label
      - resource
      - user
      title: RelationNodeType
    RelationNodeVector:
      properties:
        node_value:
          type: string
          title: Node Value
        vector:
          items:
            type: number
          type: array
          title: Vector
      type: object
      required:
      - node_value
      - vector
      title: RelationNodeVector
    RelationType:
      type: string
      enum:
      - ABOUT
      - CHILD
      - COLAB
      - ENTITY
      - OTHER
      - SYNONYM
      title: RelationType
    Representation:
      properties:
        is_a_table:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is A Table
        reference_file:
          anyOf:
          - type: string
          - type: 'null'
          title: Reference File
      type: object
      title: Representation
    Resource:
      properties:
        id:
          type: string
          title: Id
        slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Slug
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
        summary:
          anyOf:
          - type: string
          - type: 'null'
          title: Summary
        icon:
          anyOf:
          - type: string
          - type: 'null'
          title: Icon
        thumbnail:
          anyOf:
          - type: string
          - type: 'null'
          title: Thumbnail
        metadata:
          anyOf:
          - $ref: '#/components/schemas/Metadata'
          - type: 'null'
        usermetadata:
          anyOf:
          - $ref: '#/components/schemas/UserMetadata'
          - type: 'null'
        fieldmetadata:
          anyOf:
          - items:
              $ref: '#/components/schemas/UserFieldMetadata'
            type: array
          - type: 'null'
          title: Fieldmetadata
        computedmetadata:
          anyOf:
          - $ref: '#/components/schemas/ComputedMetadata'
          - type: 'null'
        created:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created
        modified:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Modified
        last_seqid:
          anyOf:
          - type: integer
          - type: 'null'
          title: Last Seqid
        last_account_seq:
          anyOf:
          - type: integer
          - type: 'null'
          title: Last Account Seq
        queue:
          anyOf:
          - $ref: '#/components/schemas/QueueType'
          - type: 'null'
        hidden:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Hidden
        origin:
          anyOf:
          - $ref: '#/components/schemas/Origin'
          - type: 'null'
        extra:
          anyOf:
          - $ref: '#/components/schemas/Extra'
          - type: 'null'
        relations:
          anyOf:
          - items:
              $ref: '#/components/schemas/Relation'
            type: array
          - type: 'null'
          title: Relations
        data:
          anyOf:
          - $ref: '#/components/schemas/ResourceData'
          - type: 'null'
        security:
          anyOf:
          - $ref: '#/components/schemas/ResourceSecurity'
          - type: 'null'
          title: Security
          description: Resource security metadata
      type: object
      required:
      - id
      title: Resource
    ResourceCreated:
      properties:
        uuid:
          type: string
          title: Uuid
        elapsed:
          anyOf:
          - type: number
          - type: 'null'
          title: Elapsed
        seqid:
          anyOf:
          - type: integer
          - type: 'null'
          title: Seqid
      type: object
      required:
      - uuid
      title: ResourceCreated
    ResourceData:
      properties:
        texts:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/TextFieldData'
            type: object
          - type: 'null'
          title: Texts
        files:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/FileFieldData'
            type: object
          - type: 'null'
          title: Files
        links:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/LinkFieldData'
            type: object
          - type: 'null'
          title: Links
        conversations:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/ConversationFieldData'
            type: object
          - type: 'null'
          title: Conversations
        generics:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/GenericFieldData'
            type: object
          - type: 'null'
          title: Generics
        key_values:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/KeyValueFieldData'
            type: object
          - type: 'null'
          title: Key Values
      type: object
      title: ResourceData
    ResourceList:
      properties:
        resources:
          items:
            $ref: '#/components/schemas/Resource'
          type: array
          title: Resources
        pagination:
          $ref: '#/components/schemas/ResourcePagination'
      type: object
      required:
      - resources
      - pagination
      title: ResourceList
    ResourcePagination:
      properties:
        page:
          type: integer
          title: Page
        size:
          type: integer
          title: Size
        last:
          type: boolean
          title: Last
      type: object
      required:
      - page
      - size
      - last
      title: ResourcePagination
    ResourceProcessingStatus:
      type: string
      enum:
      - PENDING
      - PROCESSED
      - ERROR
      - EMPTY
      - BLOCKED
      - EXPIRED
      title: ResourceProcessingStatus
    ResourceSecurity:
      properties:
        access_groups:
          items:
            type: string
          type: array
          title: Access groups
          description: List of group ids that can access the resource.
          default: []
      type: object
      title: ResourceSecurity
      description: Security metadata for the resource
    RetrievalAgentExportRequest:
      properties:
        passphrase:
          type: string
          minLength: 16
          title: Passphrase
          description: Passphrase to encrypt the exported configuration. Will be required
            for import.
      type: object
      required:
      - passphrase
      title: RetrievalAgentExportRequest
    Row:
      properties:
        cell:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Cell
      type: object
      title: Row
    RowsPreview:
      properties:
        sheets:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/Sheet'
            type: object
          - type: 'null'
          title: Sheets
      type: object
      title: RowsPreview
    Rule:
      properties:
        prompt:
          anyOf:
          - type: string
          - type: 'null'
          title: Prompt
      type: object
      title: Rule
    Rules:
      properties:
        rules:
          items:
            anyOf:
            - $ref: '#/components/schemas/Rule'
            - type: string
          type: array
          title: Rules
          description: List of rules that the workflow should follow. Each rule can
            be a string or a Rule object with a prompt.
      type: object
      title: Rules
    Sentence:
      properties:
        start:
          anyOf:
          - type: integer
          - type: 'null'
          title: Start
        end:
          anyOf:
          - type: integer
          - type: 'null'
          title: End
        key:
          anyOf:
          - type: string
          - type: 'null'
          title: Key
      type: object
      title: Sentence
    SessionData:
      properties:
        slug:
          type: string
          title: Slug
        name:
          type: string
          title: Name
        summary:
          type: string
          title: Summary
        data:
          type: string
          title: Data
        format:
          $ref: '#/components/schemas/TextFormat'
      type: object
      required:
      - slug
      - name
      - summary
      - data
      - format
      title: SessionData
    Sheet:
      properties:
        rows:
          anyOf:
          - items:
              $ref: '#/components/schemas/Row'
            type: array
          - type: 'null'
          title: Rows
      type: object
      title: Sheet
    Source:
      type: string
      enum:
      - WEB
      - DESKTOP
      - API
      - PYSDK
      title: Source
    SyncMetadata:
      properties:
        file_id:
          type: string
          title: File Id
          description: Identifier of the file in the origin cloud storage system
        auth_provider:
          type: string
          title: Auth Provider
          description: Authentication provider used to access the origin cloud storage
            system
        content_hash:
          type: string
          title: Content Hash
          description: Content hash of the file in the origin cloud storage system.
            The hash algorithm used depends on the origin system.
      type: object
      required:
      - file_id
      - auth_provider
      - content_hash
      title: SyncMetadata
    TextFieldData:
      properties:
        value:
          anyOf:
          - $ref: '#/components/schemas/FieldText'
          - type: 'null'
        extracted:
          anyOf:
          - $ref: '#/components/schemas/TextFieldExtractedData'
          - type: 'null'
        error:
          anyOf:
          - $ref: '#/components/schemas/Error'
          - type: 'null'
        status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        errors:
          anyOf:
          - items:
              $ref: '#/components/schemas/Error'
            type: array
          - type: 'null'
          title: Errors
      type: object
      title: TextFieldData
    TextFieldExtractedData:
      properties:
        text:
          anyOf:
          - $ref: '#/components/schemas/ExtractedText'
          - type: 'null'
        metadata:
          anyOf:
          - $ref: '#/components/schemas/FieldComputedMetadata'
          - type: 'null'
        large_metadata:
          anyOf:
          - $ref: '#/components/schemas/LargeComputedMetadata'
          - type: 'null'
        vectors:
          anyOf:
          - $ref: '#/components/schemas/VectorObject'
          - type: 'null'
        question_answers:
          anyOf:
          - $ref: '#/components/schemas/FieldQuestionAnswers'
          - type: 'null'
        relation_node_vectors:
          anyOf:
          - additionalProperties:
              items:
                $ref: '#/components/schemas/RelationNodeVector'
              type: array
            type: object
          - type: 'null'
          title: Relation Node Vectors
        relation_edge_vectors:
          anyOf:
          - additionalProperties:
              items:
                $ref: '#/components/schemas/RelationEdgeVector'
              type: array
            type: object
          - type: 'null'
          title: Relation Edge Vectors
      type: object
      title: TextFieldExtractedData
    TextFormat:
      type: string
      enum:
      - PLAIN
      - HTML
      - RST
      - MARKDOWN
      - JSON
      - KEEP_MARKDOWN
      - JSONL
      - PLAIN_BLANKLINE_SPLIT
      title: TextFormat
    TypeParagraph:
      type: string
      enum:
      - TEXT
      - OCR
      - INCEPTION
      - DESCRIPTION
      - TRANSCRIPT
      - TITLE
      - TABLE
      title: TypeParagraph
    UserClassification:
      properties:
        labelset:
          type: string
          title: The ID of the labelset
        label:
          type: string
          title: The label assigned from the labelset
        cancelled_by_user:
          type: boolean
          title: Cancelled By User
          default: false
      type: object
      required:
      - labelset
      - label
      title: UserClassification
    UserFieldMetadata:
      properties:
        paragraphs:
          items:
            $ref: '#/components/schemas/ParagraphAnnotation'
          type: array
          title: Paragraphs
          default: []
        question_answers:
          items:
            $ref: '#/components/schemas/QuestionAnswerAnnotation'
          type: array
          title: Question Answers
          default: []
        field:
          $ref: '#/components/schemas/FieldID'
      type: object
      required:
      - field
      title: UserFieldMetadata
      description: Field-level metadata set by the user via the rest api
    UserMetadata:
      properties:
        classifications:
          items:
            $ref: '#/components/schemas/UserClassification'
          type: array
          title: Classifications
          default: []
        relations:
          items:
            $ref: '#/components/schemas/Relation'
          type: array
          title: Relations
          default: []
      type: object
      title: UserMetadata
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Vector:
      properties:
        start:
          anyOf:
          - type: integer
          - type: 'null'
          title: Start
        end:
          anyOf:
          - type: integer
          - type: 'null'
          title: End
        start_paragraph:
          anyOf:
          - type: integer
          - type: 'null'
          title: Start Paragraph
        end_paragraph:
          anyOf:
          - type: integer
          - type: 'null'
          title: End Paragraph
        vector:
          anyOf:
          - items:
              type: number
            type: array
          - type: 'null'
          title: Vector
      type: object
      title: Vector
    VectorObject:
      properties:
        vectors:
          anyOf:
          - $ref: '#/components/schemas/Vectors'
          - type: 'null'
        split_vectors:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/Vectors'
            type: object
          - type: 'null'
          title: Split Vectors
        deleted_splits:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Deleted Splits
      type: object
      title: VectorObject
    Vectors:
      properties:
        vectors:
          anyOf:
          - items:
              $ref: '#/components/schemas/Vector'
            type: array
          - type: 'null'
          title: Vectors
      type: object
      title: Vectors
    WorkflowData:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        parameters:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Parameters
        rules:
          anyOf:
          - $ref: '#/components/schemas/Rules'
          - type: 'null'
        required:
          items:
            type: string
          type: array
          title: Required
      type: object
      required:
      - id
      - name
      - description
      - parameters
      title: WorkflowData
    WorkflowInput:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        parameters:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Parameters
        rules:
          $ref: '#/components/schemas/Rules'
        required:
          items:
            type: string
          type: array
          title: Required
      type: object
      required:
      - id
      - name
      title: WorkflowInput
    WorkflowUpdate:
      properties:
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        parameters:
          additionalProperties: true
          type: object
          title: Parameters
        required:
          items:
            type: string
          type: array
          title: Required
        rules:
          anyOf:
          - $ref: '#/components/schemas/Rules'
          - type: 'null'
      type: object
      required:
      - name
      - description
      - parameters
      title: WorkflowUpdate
