Parsing API

Queue a parsing job

Queue a parser batch from files you already uploaded with POST /parser/upload-url. Returns a batch ID you can poll with GET /parser/jobs/{batchId}.

post/parser/jobs

Request

  • Base URL: https://contracko.com/api/v1
  • URL: https://contracko.com/api/v1/parser/jobs
  • Auth: one of:
    • API key in header x-contracko-api-key
    • HTTP bearer

Request body

aiInferenceMode'fast' | 'standard'

AI inference mode. Defaults to fast; choose standard for background work.

outputFormat'json' | 'csv' | 'xlsx'

Requested export format for parser output. csv returns a ZIP bundle with one CSV per logical table; xlsx returns a multi-sheet workbook.

runKind'extraction' | 'review'

Request type. extraction performs structured extraction only; review adds AI analysis and costs extra credits.

outputLanguage'source' | 'en' | 'nl' | 'de' | 'fr' | 'es' | 'it' | 'pt' | 'zh-Hans' | 'zh-Hant' | 'ja' | 'ko' | 'ar' | 'hi' | 'bn' | 'ta' | 'te' | 'mr' | 'ur' | 'id' | 'vi' | 'th' | 'pl' | 'sv' | 'da' | 'no' | 'fi' | 'tr' | 'ru' | 'uk' | 'ro' | 'cs' | 'hu' | 'el'

Optional AI output language. Omit to use the workspace default; use source to preserve the document language.

outputTemplateId'standard'

Export layout template. standard keeps the default Contracko parser columns.

categoryIdstring uuid

Optional extraction template / contract type UUID. When provided, custom fields from that template are extracted.

Response

Batch queued.

batchIdstring required

Batch ID to use with GET /parser/jobs/{batchId}

creditsNeededinteger required

Credits reserved for this batch

Changes

No recorded changes to this operation across all 1 revision of this API.