NAnace
public-api

Parse Async

Start a parse job; returns a job_id to poll.

post/api/v1/parse_async

Request

Request body

idempotency_keystring nullable

Repeating a POST with the same key returns the original job instead of starting a new one.

Response

Idempotent replay — a job with this idempotency_key already exists; body is its current state.

job_idstring uuid required
actionstring required

One of parse/ground/categorize/extract.

statusstring required

One of pending/running/succeeded/failed.

is_exampleboolean

True for provisioned Playground example jobs.

created_atstring date-time required
started_atstring date-time nullable
completed_atstring date-time nullable
credits_usedinteger nullable

Credits charged to this job per the ledger. 0 for failed/cancelled jobs (never charged) and zero-credit example jobs; null while the job is non-terminal (not counted yet) or for a succeeded job predating the ledger.

Changes

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