Doctly Documents API

Upload documents for Markdown conversion and retrieve results.

Operations 4

GET /documents List documents #
POST /documents Process (upload) a document #
GET /documents/{id} Get a document #
DELETE /documents/{id} Delete a document #

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/doctly-ai-documents-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

doctly-ai-documents-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Doctly Documents API
  description: Doctly converts PDF, DOCX, and image documents into clean Markdown or structured JSON. Submit a document for asynchronous processing, then poll the document by id (or receive a webhook callback) to retrieve the signed output_file_url. Custom extractors run structured-data extraction against a document. All requests authenticate with a Bearer API key.
  termsOfService: https://doctly.ai/terms
  contact:
    name: Doctly Support
    url: https://docs.doctly.ai
  version: '1.0'
servers:
- url: https://api.doctly.ai/api/v1
security:
- bearerAuth: []
tags:
- name: Documents
  description: Upload documents for Markdown conversion and retrieve results.
paths:
  /documents:
    get:
      operationId: listDocuments
      tags:
      - Documents
      summary: List documents
      description: Retrieve a paginated list of your documents with optional filtering.
      parameters:
      - name: skip
        in: query
        schema:
          type: integer
          default: 0
        description: Pagination offset.
      - name: limit
        in: query
        schema:
          type: integer
          default: 100
          maximum: 100
        description: Records per page (max 100).
      - name: extractor_id
        in: query
        schema:
          type: string
          format: uuid
        description: Filter by extractor.
      - name: no_extractor
        in: query
        schema:
          type: boolean
          default: false
        description: Return only documents without an extractor.
      - name: search
        in: query
        schema:
          type: string
        description: Search by filename.
      - name: date_from
        in: query
        schema:
          type: string
          format: date-time
        description: Start date filter (ISO 8601).
      - name: date_to
        in: query
        schema:
          type: string
          format: date-time
        description: End date filter (ISO 8601).
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentsPublic'
        '401':
          description: Unauthorized
    post:
      operationId: processDocument
      tags:
      - Documents
      summary: Process (upload) a document
      description: Upload a document for asynchronous processing. Supports PDF, DOCX, and image files (PNG, JPG, JPEG, WEBP, GIF), max 100MB. Provide either a file or a url. Returns a document record in PENDING status; poll GET /documents/{id} or supply a callback_url for webhook notification.
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ProcessDocumentRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentCreateResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '413':
          description: File too large (exceeds 100MB)
  /documents/{id}:
    get:
      operationId: getDocument
      tags:
      - Documents
      summary: Get a document
      description: Retrieve detailed information about a specific document, including the signed output_file_url and file_url once processing is COMPLETED.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: Document ID.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentPublicWithLink'
        '404':
          description: Not Found
    delete:
      operationId: deleteDocument
      tags:
      - Documents
      summary: Delete a document
      description: Delete a document and its associated files.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: Document ID.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
        '404':
          description: Not Found
components:
  schemas:
    DocumentPublicWithLink:
      allOf:
      - $ref: '#/components/schemas/DocumentPublic'
      - type: object
        properties:
          output_file_url:
            type:
            - string
            - 'null'
            format: uri
            description: Signed download link for the processed output (Markdown/JSON).
          file_url:
            type:
            - string
            - 'null'
            format: uri
            description: Signed download link for the original uploaded file.
          output_file_name:
            type:
            - string
            - 'null'
    DocumentCreateResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        file_name:
          type: string
        file_size:
          type: integer
          description: Size in bytes.
        page_count:
          type:
          - integer
          - 'null'
          description: Number of pages; null until processed.
        status:
          $ref: '#/components/schemas/DocumentStatus'
        accuracy:
          $ref: '#/components/schemas/AccuracyLevel'
        extractor_id:
          type:
          - string
          - 'null'
          format: uuid
        created_at:
          type: string
          format: date-time
    DocumentPublic:
      type: object
      properties:
        id:
          type: string
          format: uuid
        file_name:
          type: string
        file_size:
          type: integer
        page_count:
          type:
          - integer
          - 'null'
        status:
          $ref: '#/components/schemas/DocumentStatus'
        accuracy:
          $ref: '#/components/schemas/AccuracyLevel'
        extractor_id:
          type:
          - string
          - 'null'
          format: uuid
        created_at:
          type: string
          format: date-time
    ProcessDocumentRequest:
      type: object
      properties:
        file:
          type: string
          format: binary
          description: Document file to upload (PDF, DOCX, PNG, JPG, JPEG, WEBP, GIF; max 100MB).
        url:
          type: string
          format: uri
          description: Alternative to file - a remote document URL to fetch and process.
        accuracy:
          $ref: '#/components/schemas/AccuracyLevel'
        extractor_id:
          type: string
          format: uuid
          description: Optional custom extractor to run instead of standard Markdown conversion.
        page_separator:
          type: boolean
          default: true
          description: Include page break markers in the Markdown output.
        skip_images:
          type: boolean
          default: false
          description: Omit image extraction when true.
        callback_url:
          type: string
          format: uri
          description: Webhook URL notified when processing completes.
    AccuracyLevel:
      type: string
      enum:
      - lite
      - ultra
      default: lite
      description: Conversion accuracy. lite is faster (default); ultra generates multiple versions per page and selects the most accurate, but takes longer.
    Message:
      type: object
      properties:
        message:
          type: string
    DocumentsPublic:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DocumentPublic'
        count:
          type: integer
    DocumentStatus:
      type: string
      enum:
      - PENDING
      - PROCESSING
      - COMPLETED
      - FAILED
      - EXPIRED
      description: Lifecycle status of a document processing job.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Bearer API key, sent as `Authorization: Bearer YOUR_API_KEY`.'