Retrieve Result

This endpoint is used to query the result of an asynchronous request.

POST /v1/agents/async-result

cURL

cURL

curl --request POST \
  --url https://api.z.ai/api/v1/agents/async-result \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "<string>",
  "async_id": "<string>"
}
'

import requests

url = "https://api.z.ai/api/v1/agents/async-result"

payload = {
    "agent_id": "<string>",
    "async_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({agent_id: '<string>', async_id: '<string>'})
};

fetch('https://api.z.ai/api/v1/agents/async-result', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.z.ai/api/v1/agents/async-result")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"<string>\",\n  \"async_id\": \"<string>\"\n}")
  .asString();

200

{
  "status": "<string>",
  "agent_id": "<string>",
  "async_id": "<string>",
  "choices": [
    {
      "index": 123,
      "finish_reason": "<string>",
      "message": [
        {
          "role": "<string>",
          "content": [
            {
              "type": "<string>",
              "video_url": "<string>"
            }
          ]
        }
      ]
    }
  ]
}

{
  "status": "<string>",
  "agent_id": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Use the following format for authentication: Bearer

Headers

Accept-Language · enum<string> · default: en-US,en

Config desired response language for HTTP requests.

Available options: en-US,en

Example:

"en-US,en"

Body

application/json

agent_id · string

Agent ID: vidu_template_agent.

async_id · string

Task ID from async response.

Response

200

application/json

Processing successful

status · string

pending (processing), success (completed), failed (failed).

agent_id · string

Agent ID

async_id · string

Asynchronous task ID.

choices · object[]

Agent output.

Hide child attributes

choices. index · integer

Result index.

choices. finish_reason · string

Reason for model inference termination. Can be ‘stop’, ‘tool_calls’, ‘length’, ‘sensitive’, or ‘network_error’.

choices. message · object[]

Hide child attributes

choices.message. role · string

Role: fixed as assistant.

choices.message. content · object[]

Video file metadata

Hide child attributes

choices.message.content. type · string

object type: video_url.

choices.message.content. video_url · string

MP4 video URL.