Skip to main content
PUT
/
messages
/
batch
Batch Update Messages
curl --request PUT \
  --url https://api.example.com/messages/batch \
  --header 'Content-Type: application/json' \
  --data '
{
  "task_id": "<string>",
  "updates": {}
}
'
[
  {
    "task_id": "<string>",
    "content": {
      "content": "<string>",
      "type": "text",
      "style": "static",
      "format": "plain",
      "attachments": [
        {
          "file_id": "<string>",
          "name": "<string>",
          "size": 123,
          "type": "<string>"
        }
      ]
    },
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.gp.scale.com/llms.txt

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

Body

application/json
​
task_id
string
required
​
updates
The updates to apply to the messages. The key is the TaskMessage id and the value is the TaskMessageContent to update the message with. · object
required

Response

Successful Response

​
task_id
string
required

ID of the task this message belongs to

​
content
TextContent · object
required

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

​
id
string | null

The task message's unique id

​
streaming_status
enum<string> | null
Available options:
IN_PROGRESS,
DONE
​
created_at
string<date-time> | null

The timestamp when the message was created

​
updated_at
string<date-time> | null

The timestamp when the message was last updated