Skip to content

Create custom job

POST/v1/jobs/custom-jobs/

Run the custom processing set up for your account. Custom jobs are solutions built on the ByteIt platform for requirements beyond the standard parse, extract and classification jobs (a specific document family, output layout or business rule). Follow and download them like any other job with jobs; jobs.download_result can include the extra files a custom job produces. To get one for your needs, contact ByteIt.

Body

Sent as multipart/form-data.

  • filesarray of files

    Upload up to 25 documents for one custom job.

  • schemaobject or null

    Optional JSON extraction schema for the custom job.

  • user_promptstring or null

    Optional user prompt appended to the custom job request.

  • nicknamestring or null

    Optional nickname for easier job identification.

Returns

200 with a JSON object.

Show response attributesHide response attributes
  • detailstringRequired
  • custom_jobobjectRequired
    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 custom

    • extraction_schemaobject or null

      JSON schema the job extracted with, when it extracts data.

    • user_promptstring or null

      Instructions you gave the job.

    • file_namesarray of strings

      Names of the uploaded files, in upload order.

    • total_page_countinteger or null

      Pages across all uploaded files.

    • document_typesarray of strings

      File type of each uploaded file, in upload order.

    • has_extrasboolean

      Whether an extras ZIP can be downloaded.

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