Skip to content

Create parse job

POST/v1/jobs/parse-jobs/

Create a parse job entry for document processing.

Body

Sent as multipart/form-data.

  • filefile or null

    Document to parse (localfile connector). Use 'files' for several.

  • filesarray of files

    Upload up to 25 files in one request (localfile connector only). Mutually exclusive with 'file'.

  • nicknamestring or null

    Optional nickname for easier job identification.

  • output_formatstring or null

    Output format for the result: 'txt', 'json', 'html', 'md', 'zip'

    One of txt, json, html, md, zip

  • input_connectorstring

    Where to read the document from: 'localfile' (upload) or 's3'.

    One of localfile, s3

    Default localfile

  • input_connection_dataobject or null

    Configuration for the input connector. For localfile: leave empty.

    Show child attributesHide child attributes
    • source_bucketstring

      S3 bucket that holds the source object(s).

    • source_path_inside_bucketstring

      Single object key inside the bucket (mutually exclusive with source_paths).

    • source_pathsarray of strings

      Bulk object keys inside the bucket (mutually exclusive with source_path_inside_bucket).

  • output_connectorstring or null

    Where to deliver the result: 's3' (your bucket, see output_connection_data). Leave empty to download it from ByteIt.

    One of localfile, s3

  • output_connection_dataobject or null

    Configuration for the output connector.

    Show child attributesHide child attributes
    • bucketstring

      Destination S3 bucket.

    • pathstring

      Destination key prefix or object path inside the bucket.

  • processing_optionsobject or null

    Processing options for the job.

    Show child attributesHide child attributes
    • languagesarray of strings
    • page_rangestring
    • image_annotationsboolean

      Default false

    • force_image_annotationsboolean

      Default false

    • table_enrichmentboolean

      Default false

    • parse_typestring

      One of auto, complex, handwritten

      Default auto

    • output_formatstring

      One of txt, json, html, md, zip

      Default txt

  • queue_for_batchboolean or null

    When true, the job is accepted and held in queued status instead of starting processing immediately.

    Default false

Returns

200 with a JSON object.

Show response attributesHide response attributes
  • detailstringRequired
  • parse_jobobject or null
    Show child attributesHide child attributes
    • job_idstringRequired

      Unique job identifier.

    • nicknamestring or null

      Display name you gave the job.

    • processing_statusstringRequired

      Where the job is in its lifecycle: pending (received, being inspected), queued (accepted, waiting to be processed), processing, completed (the result can be downloaded) or failed (the job's error and error_code say why). completed and failed are final.

      One of pending, processing, completed, failed, queued

    • created_atstring or null

      When the job was created.

    • updated_atstring or null

      When the job last changed.

    • processing_time_secondsnumber or null

      Time the job took to process, once it has finished.

    • credits_costnumber

      Credits charged for the job.

    • errorstring or null

      Why the job failed, when it did.

    • error_codestring or null

      Stable error code of a failed job, from the same vocabulary as API errors.

    • file_namestring or null

      Name of the uploaded file, when the job has one.

    • page_countinteger or null

      Pages in the document, once it has been inspected.

    • job_typestringRequired

      One of parse

    • file_sizeinteger or null

      Size of the document in bytes.

    • output_formatstring or null

      Format of the parsed result.

    • processing_optionsobject or null

      Options the document was parsed with.

      Show child attributesHide child attributes
      • languagesarray of strings
      • page_rangestring
      • image_annotationsboolean

        Default false

      • force_image_annotationsboolean

        Default false

      • table_enrichmentboolean

        Default false

      • parse_typestring

        One of auto, complex, handwritten

        Default auto

      • output_formatstring

        One of txt, json, html, md, zip

        Default txt

    • input_connectorstring or nullRequired

      Where the document came from: localfile (uploaded) or s3.

    • output_connectorstring or nullRequired

      Where the result is delivered: localfile (download) or s3.

    • billable_unitstring or null

      Unit the job is billed in: page, char, cell or pixel.

    • billable_quantityinteger or null

      Quantity billed, in billable_unit.

  • countinteger or null
  • parse_jobsarray of objects or null
    Show child attributesHide child attributes
    • job_idstringRequired

      Unique job identifier.

    • nicknamestring or null

      Display name you gave the job.

    • processing_statusstringRequired

      Where the job is in its lifecycle: pending (received, being inspected), queued (accepted, waiting to be processed), processing, completed (the result can be downloaded) or failed (the job's error and error_code say why). completed and failed are final.

      One of pending, processing, completed, failed, queued

    • created_atstring or null

      When the job was created.

    • updated_atstring or null

      When the job last changed.

    • processing_time_secondsnumber or null

      Time the job took to process, once it has finished.

    • credits_costnumber

      Credits charged for the job.

    • errorstring or null

      Why the job failed, when it did.

    • error_codestring or null

      Stable error code of a failed job, from the same vocabulary as API errors.

    • file_namestring or null

      Name of the uploaded file, when the job has one.

    • page_countinteger or null

      Pages in the document, once it has been inspected.

    • job_typestringRequired

      One of parse

    • file_sizeinteger or null

      Size of the document in bytes.

    • output_formatstring or null

      Format of the parsed result.

    • processing_optionsobject or null

      Options the document was parsed with.

      Show child attributesHide child attributes
      • languagesarray of strings
      • page_rangestring
      • image_annotationsboolean

        Default false

      • force_image_annotationsboolean

        Default false

      • table_enrichmentboolean

        Default false

      • parse_typestring

        One of auto, complex, handwritten

        Default auto

      • output_formatstring

        One of txt, json, html, md, zip

        Default txt

    • input_connectorstring or nullRequired

      Where the document came from: localfile (uploaded) or s3.

    • output_connectorstring or nullRequired

      Where the result is delivered: localfile (download) or s3.

    • billable_unitstring or null

      Unit the job is billed in: page, char, cell or pixel.

    • billable_quantityinteger or null

      Quantity billed, in billable_unit.

  • failed_filesarray of objects or null
    Show child attributesHide child attributes
    • file_namestringRequired
    • errorstringRequired

Errors

Every error has the same JSON body. See Errors for the error codes and when to retry.

  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 410Gone
  • 413Request Entity Too Large
  • 422Unprocessable Entity
  • 429Too Many Requests
  • 500Internal Server Error