Skip to main content
GET
Get Annotation Reply Job Status

Authorizations

Authorization
string
header
required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path Parameters

action
enum<string>
required

Action type, must match the Configure Annotation Reply call.

Available options:
enable,
disable
job_id
string<uuid>
required

Job ID returned by Configure Annotation Reply.

Response

Successfully retrieved task status.

job_id
string<uuid>

Job ID from the Configure Annotation Reply call.

job_status
string

Current job status. waiting for queued, processing for in progress, completed when finished, error if failed.

error_msg
string

Error message describing why the job failed. Empty string when job_status is not error.