dokyumi-com API

openapi: 3.1.0
info:
  title: dokyumi-com API
  version: '2026-10-30'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-30: 3 operation(s) read from 40 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; dokyumi-com has published no machine-readable contract that the
    pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 2
    documentation: 1
    pages-with-code: 2
    pages-read: 40
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-30'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://dokyumi.com/docs
  - https://dokyumi.com/workflows/tax-season-client-intake
  - https://dokyumi.com/workflows/bill-of-lading-shipment-entry
  - https://dokyumi.com/workflows/restricted-donation-acknowledgment-indexing
  - https://dokyumi.com/sic
  - https://dokyumi.com/document-ai
  - https://dokyumi.com/document-ai/custom-schema-extraction
  - https://dokyumi.com/about
  - https://dokyumi.com/workflows/self-employed-borrower-tax-intake
  - https://dokyumi.com/workflows/vendor-w9-onboarding
  - https://dokyumi.com/workflows/proof-of-delivery-billing
  - https://dokyumi.com/workflows/freight-invoice-audit
  - https://dokyumi.com/workflows/customs-document-intake
  - https://dokyumi.com/workflows/grant-application-intake
  - https://dokyumi.com/workflows/grant-award-letter-register
  - https://dokyumi.com/workflows/grant-expenditure-report-capture
  - https://dokyumi.com/workflows/lease-rent-schedule
  - https://dokyumi.com/workflows/rent-roll-acquisition-intake
  - https://dokyumi.com/workflows/cam-reconciliation-preparation
  - https://dokyumi.com/workflows/construction-pay-application-review
  - https://dokyumi.com/workflows/subcontractor-lien-waiver-intake
  - https://dokyumi.com/workflows/commercial-property-t12-intake
  - https://dokyumi.com/workflows/lease-amendment-register-capture
  - https://dokyumi.com/workflows/tenant-application-record-preparation
  - https://dokyumi.com/workflows/security-deposit-ledger-intake
  - https://dokyumi.com/workflows/move-in-inspection-checklist-capture
  - https://dokyumi.com/workflows/move-out-damage-estimate-preparation
  - https://dokyumi.com/workflows/tenant-estoppel-certificate-intake
  - https://dokyumi.com/workflows/property-tax-notice-accounting-intake
  - https://dokyumi.com/workflows/hoa-resale-statement-intake
  - https://dokyumi.com/workflows/property-mortgage-statement-accounting-inputs
  - https://dokyumi.com/workflows/property-utility-allocation-statement-capture
  - https://dokyumi.com/workflows/property-management-owner-statement-capture
  - https://dokyumi.com/workflows/maintenance-proposal-work-order-preparation
  - https://dokyumi.com/workflows/tenant-rent-change-notice-indexing
  - https://dokyumi.com/workflows/recorded-deed-ownership-register-capture
  - https://dokyumi.com/workflows/title-commitment-exception-indexing
  - https://dokyumi.com/workflows/property-purchase-contract-deadline-capture
  - https://dokyumi.com/workflows/subcontract-change-order-intake
  - https://dokyumi.com/workflows/certified-payroll-submission-intake
paths:
  /api/sic/classify:
    post:
      operationId: post_api_sic_classify
      tags:
      - Api
      summary: Classify business industry codes using application and bank statement documents.
      x-source: https://dokyumi.com/sic
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiSicClassifyRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiSicClassifyResponse'
      x-evidence:
        kind: documentation
  /api/v1/extract:
    post:
      operationId: post_api_v1_extract
      tags:
      - Api
      summary: POST /api/v1/extract
      x-source: https://dokyumi.com/docs
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1ExtractResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://dokyumi.com/api/v1/extract  -H "Authorization: Bearer dk_live_your_api_key"  -F "file=@invoice.pdf"  -F
          "schema=invoice-parser" 5 Handle the response Check status — completed means there are no validation errors or known below-threshold
          confidence scores. review means you must inspect both validation.errors and validation.low_confidence_fields . Your structured data
          is in data'
  /api/v1/schemas:
    get:
      operationId: get_api_v1_schemas
      tags:
      - Api
      summary: GET /api/v1/schemas
      x-source: https://dokyumi.com/docs
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1SchemasResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://dokyumi.com/api/v1/schemas  -H \"Authorization: Bearer dk_live_your_api_key\" //Response\n{\n \"schemas\": [\n\
          \ {\n \"slug\": \"invoice-parser\",\n \"name\": \"Invoice Parser\",\n \"description\": \"Extracts vendor, amounts, and line items from\
          \ invoices\",\n \"ocr_mode\": \"standard\",\n \"fields\": [\n { \"key\": \"vendor_name\", \"type\": \"string\", \"required\": true },\n\
          \ { \"key\": \"invoice_number\", \"type\": \"string\", \"requi"
components:
  schemas:
    PostApiSicClassifyRequest:
      type: object
      properties:
        files:
          type: string
          description: Up to four application or bank-statement files (PDF, JPG, or PNG)
      required:
      - files
    PostApiSicClassifyResponse:
      type: object
      properties:
        business_name:
          type: string
          description: Name of the business
        business_description:
          type: string
          description: Description of the business
        sic:
          type: object
          description: SIC classification object containing code_2digit, title_2digit, code_4digit, and title_4digit
        confidence:
          type: number
          description: Model-reported confidence score
        needs_review:
          type: boolean
          description: Flag indicating whether the classification needs review
        evidence:
          type: array
          description: Array of evidence supporting the classification with source and detail fields
        alternates:
          type: array
          description: Array of plausible alternative classifications
    PostApiV1ExtractResponse:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
        request_id:
          type: string
        schema:
          type: string
        data:
          type: object
          properties:
            vendor_name:
              type: string
            invoice_number:
              type: string
            invoice_date:
              type: string
              format: date
            total_amount:
              type: number
            line_items:
              type: array
              items:
                type: object
                properties:
                  description:
                    type: string
                  quantity:
                    type: integer
                  unit_price:
                    type: number
                  amount:
                    type: number
        confidence:
          type: object
          properties:
            vendor_name:
              type: number
            invoice_number:
              type: number
            invoice_date:
              type: number
            total_amount:
              type: number
            line_items:
              type: number
        validation:
          type: object
          properties:
            valid:
              type: boolean
            errors:
              type: array
              items: {}
            low_confidence_fields:
              type: array
              items: {}
        meta:
          type: object
          properties:
            processing_time_ms:
              type: integer
            page_count:
              type: integer
            credits_used:
              type: integer
            ocr_cached:
              type: boolean
            model:
              type: string
    GetApiV1SchemasResponse:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: object
            properties:
              slug:
                type: string
              name:
                type: string
              description:
                type: string
              ocr_mode:
                type: string
              fields:
                type: array
                items:
                  type: object
                  properties:
                    key:
                      type: string
                    type:
                      type: string
                    required:
                      type: boolean
              extraction_count:
                type: integer
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api