Space Frontiers Recognition API

openapi: 3.2.0
info:
  title: Machine Library Recognition API
  version: 0.1.0
  contact:
    email: contact@machinelibrary.ai
    name: Machine Library
    url: https://machinelibrary.ai/contacts
  description: 'Search, retrieve, and synthesize scholarly and public-interest documents through Machine Library, the search and AI product by Space Frontiers Company. Document recognition endpoints (`/v1/recognitions`: PDF, EPUB, and DJVU to structured Markdown) share this host and are described at `/v1/recognitions/docs/openapi.json`; the site reference at https://machinelibrary.ai/docs/api/reference presents both specs merged.'
  license:
    identifier: MIT
    name: MIT (API description only; retrieved content retains its own rights)
  termsOfService: https://machinelibrary.ai/terms-of-service
servers:
- description: Machine Library
  url: https://api.machinelibrary.ai
- description: Space Frontiers (compatible endpoint)
  url: https://api.spacefrontiers.org
tags:
- name: Recognition
  description: 'Document recognition: PDF, EPUB, and DJVU to structured Markdown with quality reports.'
paths:
  /v1/recognitions:
    post:
      operationId: create_recognition
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                file:
                  description: PDF, EPUB, or DJVU, up to 100 MB. Format is detected from bytes.
                  format: binary
                  type: string
                languages:
                  description: Optional comma-separated OCR language hints, e.g. "eng,deu". When omitted, the language is detected from the document body, falling back to English.
                  type: string
              required:
              - file
              type: object
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecognitionSubmission'
          description: Job accepted; poll the Location header.
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '402':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecognitionError'
          description: Insufficient balance.
        '413':
          description: File exceeds the upload limit.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecognitionError'
          description: Unsupported or invalid document.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecognitionError'
          description: Active-job limit reached; wait for a job to finish.
      summary: Submit a document for recognition
      tags:
      - Recognition
      security:
      - api_key: []
      - bearer_auth: []
      - oauth2:
        - search
      description: Submit a PDF, EPUB, or DJVU file. Poll the returned job until completion; identical content for the same account is deduplicated without a new charge. A 429 active-job response means wait for an existing job to finish.
  /v1/recognitions/{id}:
    get:
      operationId: get_recognition
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecognitionJobStatus'
          description: Current job state.
        '401':
          description: Missing or invalid account credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: No such job for this account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Job status
      tags:
      - Recognition
      security:
      - api_key: []
      - bearer_auth: []
      - oauth2:
        - search
      description: Poll recognition progress for a job owned by your account. Timestamps and result links can be null while work is pending. Poll with bounded backoff.
  /v1/recognitions/{id}/report:
    get:
      description: Quality verdict, score, rejection reasons, structured extraction (sections, references), and the processing route.
      operationId: get_recognition_report
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: The recognition report.
        '401':
          description: Missing or invalid account credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: No such job, or no report yet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Structured recognition report
      tags:
      - Recognition
      security:
      - api_key: []
      - bearer_auth: []
      - oauth2:
        - search
  /v1/recognitions/{id}/result:
    get:
      operationId: get_recognition_result
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            text/markdown:
              schema:
                type: string
          description: The recognized document.
        '401':
          description: Missing or invalid account credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: No such job, or no result yet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Recognized Markdown
      tags:
      - Recognition
      security:
      - api_key: []
      - bearer_auth: []
      - oauth2:
        - search
      description: Fetch recognized Markdown for your job. A 404 can mean the job has not produced a result yet; check its status before retrying.
components:
  schemas:
    RecognitionError:
      description: The shared Machine Library error envelope.
      properties:
        detail:
          type: string
        status:
          enum:
          - error
          type: string
      type: object
    RecognitionSubmission:
      properties:
        deduplicated:
          description: True when this exact content was already submitted by you; no new charge applies.
          type: boolean
        id:
          format: uuid
          type: string
        status:
          enum:
          - pending
          - processing
          - completed
          - failed
          - quarantined
          - cancelled
          type: string
      type: object
    ApiError:
      properties:
        detail:
          oneOf:
          - type: string
          - additionalProperties: true
            properties:
              code:
                type: string
            type: object
        status:
          enum:
          - error
          type: string
      required:
      - status
      - detail
      type: object
    RecognitionJobStatus:
      properties:
        completed_at:
          description: Unix seconds
          format: int64
          type:
          - integer
          - 'null'
        created_at:
          description: Unix seconds
          format: int64
          type: integer
        error_class:
          type:
          - string
          - 'null'
        has_result:
          type: boolean
        id:
          format: uuid
          type: string
        input_format:
          enum:
          - pdf
          - epub
          - djvu
          type: string
        languages:
          items:
            type: string
          type: array
        report_url:
          type:
          - string
          - 'null'
        result_url:
          type:
          - string
          - 'null'
        started_at:
          description: Unix seconds
          format: int64
          type:
          - integer
          - 'null'
        status:
          type: string
      type: object
  securitySchemes:
    api_key:
      description: Machine Library API key from https://machinelibrary.ai/keys.
      in: header
      name: X-Api-Key
      type: apiKey
    bearer_auth:
      bearerFormat: API key or OAuth 2.0 access token
      description: Send the same API key, or an OAuth 2.0 access token, as a Bearer token.
      scheme: bearer
      type: http
    oauth2:
      description: Authorization code with mandatory S256 PKCE. Public clients use dynamic registration; see https://machinelibrary.ai/auth.md. Access spends the consenting account's credits.
      flows:
        authorizationCode:
          authorizationUrl: https://api.machinelibrary.ai/v2/oauth/authorize
          refreshUrl: https://api.machinelibrary.ai/v2/oauth/token
          scopes:
            search: Search and retrieve research documents using your account credits.
          tokenUrl: https://api.machinelibrary.ai/v2/oauth/token
      type: oauth2
externalDocs:
  description: Authentication, limits, errors, retries, and API lifecycle
  url: https://machinelibrary.ai/docs/api/operations
x-service-info:
  categories:
  - data
  - search
  docs:
    apiReference: https://machinelibrary.ai/docs/api/reference
    homepage: https://machinelibrary.ai
    llms: https://machinelibrary.ai/llms.txt
x-provenance:
  method: harvested
  publisher: Space Frontiers
  source: https://machinelibrary.ai/docs/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)