Parsing API

Check parser availability and estimated usage

Validate one or more files before upload and return the estimated usage for the batch.

post/parser/preflight

Request

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

Request body

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.

Response

Availability and estimated usage returned.

creditsNeededinteger required

Estimated credits required for this request

totalBytesinteger required

Total request payload size in bytes

errorsstring[] required

Validation messages returned during preflight

Changes

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