Skip to main content
GET
/
apps
/
annotation-reply
/
{action}
/
status
/
{job_id}
Error
A valid request URL is required to generate request examples
{
  "job_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "job_status": "completed",
  "error_msg": ""
}

Documentation Index

Fetch the complete documentation index at: https://docs.dify.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with Bearer. Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

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.