Conversation History

This endpoint is used to query the agent conversation history.Only support slides_glm_agent

POST /v1/agents/conversation

cURL

cURL

curl --request POST \
  --url https://api.z.ai/api/v1/agents/conversation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "<string>",
  "conversation_id": "<string>",
  "custom_variables": {
    "include_pdf": true,
    "pages": [
      {
        "position": 123,
        "width": 123,
        "height": 123
      }
    ]
  }
}
'

import requests

url = "https://api.z.ai/api/v1/agents/conversation"

payload = {
    "agent_id": "<string>",
    "conversation_id": "<string>",
    "custom_variables": {
        "include_pdf": True,
        "pages": [
            {
                "position": 123,
                "width": 123,
                "height": 123
            }
        ]
    }
}
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>',
    conversation_id: '<string>',
    custom_variables: {include_pdf: true, pages: [{position: 123, width: 123, height: 123}]}
  })
};

fetch('https://api.z.ai/api/v1/agents/conversation', 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/conversation")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"custom_variables\": {\n    \"include_pdf\": true,\n    \"pages\": [\n      {\n        \"position\": 123,\n        \"width\": 123,\n        \"height\": 123\n      }\n    ]\n  }\n}")
  .asString();

200

{
  "conversation_id": "<string>",
  "agent_id": "<string>",
  "choices": [
    {
      "message": [
        {
          "role": "<string>",
          "content": [
            {
              "type": "<string>",
              "tag_cn": "<string>",
              "tag_en": "<string>",
              "file_url": "<string>",
              "image_url": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "code": 123,
  "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

conversation_id · string

Conversation ID

custom_variables · object

Custom variables

Hide child attributes

custom_variables. include_pdf · boolean

Is export the pdf file

custom_variables. pages · object[]

Slides Pages

Hide child attributes

custom_variables.pages. position · number

Slide Page Position

custom_variables.pages. width · number

Slide Width, unit: pt

custom_variables.pages. height · number

Slide Height, unit: pt

Response

200

application/json

Processing successful

conversation_id · string

Conversation ID

agent_id · string

Agent ID

choices · object[]

Agent output.

Hide child attributes

choices. message · object[]

Hide child attributes

choices.message. role · string

Role: fixed as assistant.

choices.message. content · object[]

Content metadata

Hide child attributes

choices.message.content. type · string

Response Content type: file_url、image_url

choices.message.content. tag_cn · string

CN Tag.

choices.message.content. tag_en · string

EN Tag.

choices.message.content. file_url · string

Output file_url content when type is file_url

choices.message.content. image_url · string

Output image_url content when type is image_url

error · object

Hide child attributes

error. code · string

Error code.

error. message · string

Error message.