Docspeed Generation API

The Generation API from Docspeed — 3 operation(s) for generation.

Operations 3

POST /api/v1/synthesize Synthesize Endpoint #
POST /api/v1/synthesize/one Synthesize Endpoint #
POST /api/v1/synthesize/set Synthesize Set Endpoint #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/docspeed-ai:docspeed-ai-generation-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

docspeed-ai-generation-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Docspeed Ai Generation API
  version: 1.0.0
  description: 'Operations tagged Generation 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: Generation
paths:
  /api/v1/synthesize:
    post:
      tags:
      - Generation
      summary: Synthesize Endpoint
      operationId: synthesize_endpoint_api_v1_synthesize_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SynthesizeRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SynthesizeResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/synthesize/one:
    post:
      tags:
      - Generation
      summary: Synthesize Endpoint
      operationId: synthesize_endpoint_api_v1_synthesize_one_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SynthesizeRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SynthesizeResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/synthesize/set:
    post:
      tags:
      - Generation
      summary: Synthesize Set Endpoint
      operationId: synthesize_set_endpoint_api_v1_synthesize_set_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SynthesizeRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SynthesizeSetResponse'
        '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
    SynthesizeSetDocument:
      properties:
        document_key:
          type: string
          title: Document Key
        document_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Document Type
        role:
          anyOf:
          - type: string
          - type: 'null'
          title: Role
        file:
          $ref: '#/components/schemas/FileRef'
        pages:
          items:
            $ref: '#/components/schemas/SynthesizePage'
          type: array
          title: Pages
        task:
          type: string
          enum:
          - edit_document
          - generate_po
          - generate_related_document
          title: Task
        prompt:
          type: string
          title: Prompt
        source_file_ids:
          items:
            type: string
          type: array
          title: Source File Ids
        input_file_ids:
          items:
            type: string
          type: array
          title: Input File Ids
        depends_on:
          items:
            type: string
          type: array
          title: Depends On
        matching_against:
          items:
            type: string
          type: array
          title: Matching Against
        matching_policy:
          additionalProperties: true
          type: object
          title: Matching Policy
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
      type: object
      required:
      - document_key
      - file
      - task
      - prompt
      title: SynthesizeSetDocument
    FileRef:
      properties:
        file_id:
          type: string
          title: File Id
        filename:
          type: string
          title: Filename
        content_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Content Type
        size_bytes:
          type: integer
          title: Size Bytes
        created_at:
          type: number
          title: Created At
        page_count:
          type: integer
          title: Page Count
          default: 1
      type: object
      required:
      - file_id
      - filename
      - size_bytes
      - created_at
      title: FileRef
    SynthesizeSetResponse:
      properties:
        documents:
          items:
            $ref: '#/components/schemas/SynthesizeSetDocument'
          type: array
          title: Documents
        prompt:
          type: string
          title: Prompt
        source_file_ids:
          items:
            type: string
          type: array
          title: Source File Ids
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
      type: object
      required:
      - prompt
      title: SynthesizeSetResponse
    SynthesizePage:
      properties:
        page_index:
          type: integer
          title: Page Index
        width:
          type: integer
          title: Width
        height:
          type: integer
          title: Height
        image_ref:
          type: string
          title: Image Ref
      type: object
      required:
      - page_index
      - width
      - height
      - image_ref
      title: SynthesizePage
    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
    SynthesizeRequest:
      properties:
        inputs:
          items:
            $ref: '#/components/schemas/SynthesizeInput'
          type: array
          title: Inputs
        prompt:
          type: string
          title: Prompt
        execution_mode:
          type: string
          enum:
          - async
          - sync
          title: Execution Mode
          default: sync
      additionalProperties: false
      type: object
      required:
      - prompt
      title: SynthesizeRequest
    SynthesizeResponse:
      properties:
        file:
          $ref: '#/components/schemas/FileRef'
        pages:
          items:
            $ref: '#/components/schemas/SynthesizePage'
          type: array
          title: Pages
        task:
          type: string
          enum:
          - edit_document
          - generate_po
          - generate_related_document
          title: Task
        prompt:
          type: string
          title: Prompt
        source_file_ids:
          items:
            type: string
          type: array
          title: Source File Ids
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
      type: object
      required:
      - file
      - task
      - prompt
      title: SynthesizeResponse
    SynthesizeInput:
      properties:
        file_id:
          type: string
          title: File Id
        role:
          anyOf:
          - type: string
          - type: 'null'
          title: Role
        instructions:
          anyOf:
          - type: string
          - type: 'null'
          title: Instructions
      type: object
      required:
      - file_id
      title: SynthesizeInput
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- docspeed-ai-openapi.json
- openapi.json