Parsing API

Retrieve current usage

Return current usage, remaining credits, and parser batch concurrency for the workspace.

get/parser/credits

Request

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

Response

Current usage returned.

allocatedinteger required

Allocated credits in the current billing cycle

usedinteger required

Consumed credits in the current billing cycle

remaininginteger required

Available credits for new parser work

sourcePlanKeystring required

Plan identifier associated with this usage window

refreshesAtstring date-time nullable required

ISO-8601 refresh timestamp for credits

planNamestring required

Human-readable name of the current parsing plan

maxConcurrencyinteger required

Maximum concurrent parser batches

activeBatchesinteger required

Current number of active parser batches

isInTrialboolean required

Whether the parser subscription is currently in trial

Changes

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