openapi: 3.0.1
info:
  title: Doctly 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.
  - name: Extractors
    description: Manage and run custom structured-data extractors.
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
  /e:
    get:
      operationId: listExtractors
      tags:
        - Extractors
      summary: List extractors
      description: Retrieve a list of active extractors for your account.
      parameters:
        - name: skip
          in: query
          schema:
            type: integer
            default: 0
          description: Pagination offset.
        - name: limit
          in: query
          schema:
            type: integer
            default: 100
          description: Records per page.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractorsPublic'
        '401':
          description: Unauthorized
  /e/{slug}:
    post:
      operationId: runExtractor
      tags:
        - Extractors
      summary: Run an extractor
      description: >-
        Execute an extractor (by slug) against a document file or url to
        produce structured output asynchronously. Returns a document record;
        poll GET /documents/{id} or supply a callback_url.
      parameters:
        - name: slug
          in: path
          required: true
          schema:
            type: string
          description: Extractor slug identifier.
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RunExtractorRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentCreateExtractionResponse'
        '404':
          description: Not Found
  /e/{extractor_id}:
    get:
      operationId: getExtractor
      tags:
        - Extractors
      summary: Get an extractor
      description: Retrieve details of a specific extractor.
      parameters:
        - name: extractor_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Extractor ID.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractorPublic'
        '404':
          description: Not Found
    put:
      operationId: updateExtractor
      tags:
        - Extractors
      summary: Update an extractor
      description: Update an existing extractor's name or slug.
      parameters:
        - name: extractor_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Extractor ID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtractorUpdate'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractorPublic'
        '404':
          description: Not Found
    delete:
      operationId: deleteExtractor
      tags:
        - Extractors
      summary: Delete an extractor
      description: Delete an extractor (soft delete).
      parameters:
        - name: extractor_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Extractor ID.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
        '404':
          description: Not Found
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Bearer API key, sent as `Authorization: Bearer YOUR_API_KEY`.'
  schemas:
    DocumentStatus:
      type: string
      enum:
        - PENDING
        - PROCESSING
        - COMPLETED
        - FAILED
        - EXPIRED
      description: Lifecycle status of a document processing job.
    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.
    CostType:
      type: string
      enum:
        - PER_PAGE
        - PER_DOCUMENT
      description: How an extractor's credits are charged.
    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.
    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
          nullable: true
          description: Number of pages; null until processed.
        status:
          $ref: '#/components/schemas/DocumentStatus'
        accuracy:
          $ref: '#/components/schemas/AccuracyLevel'
        extractor_id:
          type: string
          format: uuid
          nullable: true
        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
          nullable: true
        status:
          $ref: '#/components/schemas/DocumentStatus'
        accuracy:
          $ref: '#/components/schemas/AccuracyLevel'
        extractor_id:
          type: string
          format: uuid
          nullable: true
        created_at:
          type: string
          format: date-time
    DocumentPublicWithLink:
      allOf:
        - $ref: '#/components/schemas/DocumentPublic'
        - type: object
          properties:
            output_file_url:
              type: string
              format: uri
              nullable: true
              description: Signed download link for the processed output (Markdown/JSON).
            file_url:
              type: string
              format: uri
              nullable: true
              description: Signed download link for the original uploaded file.
            output_file_name:
              type: string
              nullable: true
    DocumentsPublic:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DocumentPublic'
        count:
          type: integer
    RunExtractorRequest:
      type: object
      properties:
        file:
          type: string
          format: binary
          description: Document file to process.
        url:
          type: string
          format: uri
          description: Alternative to file - a remote document URL to fetch and process.
        callback_url:
          type: string
          format: uri
          description: Webhook URL notified when extraction completes.
    DocumentCreateExtractionResponse:
      allOf:
        - $ref: '#/components/schemas/DocumentCreateResponse'
        - type: object
          properties:
            extractor_id:
              type: string
              format: uuid
            extractor:
              $ref: '#/components/schemas/ExtractorPublic'
    ExtractorPublic:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        slug:
          type: string
        description:
          type: string
          nullable: true
        cost_type:
          $ref: '#/components/schemas/CostType'
        cost_credits:
          type: integer
    ExtractorsPublic:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ExtractorPublic'
        count:
          type: integer
    ExtractorUpdate:
      type: object
      properties:
        name:
          type: string
          maxLength: 255
        slug:
          type: string
          minLength: 3
          maxLength: 100
    Message:
      type: object
      properties:
        message:
          type: string