Skip to main content
get/apps/annotation-reply/{action}/status/{job_id}
Request example
Response
get/apps/annotation-reply/{action}/status/{job_id}

Authorization

Authorizationstringheaderrequired#

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

actionenum<string>required#
Action type, must match the Configure Annotation Reply call.
Options:enabledisable
job_idstringrequired#
Job ID returned by Configure Annotation Reply.

Responses

application/json
Successfully retrieved task status.
error_msgstring#
Error message describing why the job failed. Empty string when job_status is not error.
job_idstring#
Job ID from the Configure Annotation Reply call.
job_statusstring#
Current job status. waiting for queued, processing for in progress, completed when finished, error if failed.