Docspeed Chat API

openapi: 3.2.0
info:
  title: Docspeed Ai Chat API
  version: 1.0.0
  description: 'Operations tagged Chat across 2 of this provider''s published API definitions: docspeed-ai-openapi.json, openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Chat
  description: Single and multi-document chat endpoints.
paths:
  /api/v1/ask:
    post:
      tags:
      - Chat
      summary: Ask Endpoint
      operationId: ask_endpoint_api_v1_ask_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AskRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AskResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AskRequest:
      properties:
        input:
          anyOf:
          - $ref: '#/components/schemas/InputSource'
          - type: 'null'
        inputs:
          items:
            $ref: '#/components/schemas/InputSource'
          type: array
          title: Inputs
        session_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Session Id
          description: Reusable session returned by a prior document-grounded Ask response. When provided with the same ordered inputs, Docspeed reuses prepared parsing and indexing. Valid reusable Ask sessions use the generated session_id_ prefix.
        execution_mode:
          type: string
          enum:
          - async
          - sync
          title: Execution Mode
          default: async
        query:
          type: string
          title: Query
        include_grounding:
          type: boolean
          title: Include Grounding
          default: true
        response_language:
          type: string
          enum:
          - en
          - ar
          - es
          - pt
          - fr
          - de
          - nl
          - it
          - hi
          - ru
          title: Response Language
          default: en
      type: object
      required:
      - query
      title: AskRequest
    ChatCitationRegion:
      properties:
        page_index:
          type: integer
          title: Page Index
        bbox:
          $ref: '#/components/schemas/ChatCitationBBox'
        page_width:
          type: number
          title: Page Width
        page_height:
          type: number
          title: Page Height
      type: object
      required:
      - page_index
      - bbox
      - page_width
      - page_height
      title: ChatCitationRegion
    ChatCitationBBox:
      properties:
        x:
          type: number
          title: X
        y:
          type: number
          title: Y
        width:
          type: number
          title: Width
        height:
          type: number
          title: Height
      type: object
      required:
      - x
      - y
      - width
      - height
      title: ChatCitationBBox
    InputSource:
      properties:
        file_id:
          anyOf:
          - type: string
          - type: 'null'
          title: File Id
        text:
          anyOf:
          - type: string
          - type: 'null'
          title: Text
        markdown:
          anyOf:
          - type: string
          - type: 'null'
          title: Markdown
        image_base64:
          anyOf:
          - type: string
          - type: 'null'
          title: Image Base64
        pdf_base64:
          anyOf:
          - type: string
          - type: 'null'
          title: Pdf Base64
        filename:
          anyOf:
          - type: string
          - type: 'null'
          title: Filename
      type: object
      title: InputSource
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ChatCitation:
      properties:
        doc_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Doc Id
        regions:
          items:
            $ref: '#/components/schemas/ChatCitationRegion'
          type: array
          title: Regions
      type: object
      title: ChatCitation
    AskResponse:
      properties:
        answer:
          type: string
          title: Answer
        citations:
          items:
            $ref: '#/components/schemas/ChatCitation'
          type: array
          title: Citations
        doc_ids:
          items:
            type: string
          type: array
          title: Doc Ids
        session_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Session Id
          description: Reusable session for follow-up Ask requests over the same ordered inputs. Generated values use the session_id_ prefix.
      type: object
      required:
      - answer
      title: AskResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- docspeed-ai-openapi.json
- openapi.json