Parseflow Jobs API

openapi: 3.1.0
info:
  title: parseflow Admin Jobs API
  description: Document parsing, extraction, and search API
  version: 0.2.0
security:
- ApiKeyAuth: []
tags:
- name: Jobs
paths:
  /v2/jobs:
    post:
      summary: Create Job V2
      operationId: create_job_v2_v2_jobs_post
      parameters:
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-BYOK-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Byok-Key
      - name: X-RapidAPI-Paid-Entitlement
        in: header
        required: false
        schema:
          type: boolean
          default: false
          title: X-Rapidapi-Paid-Entitlement
      - name: X-Docflow-Gateway-Secret
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Docflow-Gateway-Secret
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_create_job_v2_v2_jobs_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Jobs
  /v2/jobs/{job_id}:
    get:
      summary: Get Job V2
      operationId: get_job_v2_v2_jobs__job_id__get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Jobs
  /v2/jobs/{job_id}/deliver:
    post:
      summary: Deliver Job V2
      description: 'Simulate webhook delivery for a job (useful in local testing).


        If callback_url is omitted, the job''s deliverables are recorded and a simulated attempt is stored.'
      operationId: deliver_job_v2_v2_jobs__job_id__deliver_post
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Body_deliver_job_v2_v2_jobs__job_id__deliver_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Jobs
components:
  schemas:
    Body_deliver_job_v2_v2_jobs__job_id__deliver_post:
      properties:
        callback_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Callback Url
      type: object
      title: Body_deliver_job_v2_v2_jobs__job_id__deliver_post
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Body_create_job_v2_v2_jobs_post:
      properties:
        file:
          anyOf:
          - type: string
            contentMediaType: application/octet-stream
          - type: 'null'
          title: File
        text:
          anyOf:
          - type: string
          - type: 'null'
          title: Text
        chunk_size:
          type: integer
          title: Chunk Size
          default: 2000
        overlap:
          type: integer
          title: Overlap
          default: 200
        mode:
          type: string
          title: Mode
          default: deterministic
        preset:
          anyOf:
          - type: string
          - type: 'null'
          title: Preset
        callback_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Callback Url
        byok_provider:
          anyOf:
          - type: string
          - type: 'null'
          title: Byok Provider
        byok_model:
          anyOf:
          - type: string
          - type: 'null'
          title: Byok Model
      type: object
      title: Body_create_job_v2_v2_jobs_post
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key