Update Message

curl --request PUT \
  --url https://api.example.com/messages/{message_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "task_id": "<string>",
  "content": {
    "content": "<string>",
    "type": "text",
    "style": "static",
    "format": "plain",
    "attachments": [
      {
        "file_id": "<string>",
        "name": "<string>",
        "size": 123,
        "type": "<string>"
      }
    ]
  }
}
'

import requests

url = "https://api.example.com/messages/{message_id}"

payload = {
    "task_id": "<string>",
    "content": {
        "content": "<string>",
        "type": "text",
        "style": "static",
        "format": "plain",
        "attachments": [
            {
                "file_id": "<string>",
                "name": "<string>",
                "size": 123,
                "type": "<string>"
            }
        ]
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    task_id: '<string>',
    content: {
      content: '<string>',
      type: 'text',
      style: 'static',
      format: 'plain',
      attachments: [{file_id: '<string>', name: '<string>', size: 123, type: '<string>'}]
    }
  })
};

fetch('https://api.example.com/messages/{message_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/messages/{message_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'task_id' => '<string>',
    'content' => [
        'content' => '<string>',
        'type' => 'text',
        'style' => 'static',
        'format' => 'plain',
        'attachments' => [
                [
                                'file_id' => '<string>',
                                'name' => '<string>',
                                'size' => 123,
                                'type' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/messages/{message_id}"

	payload := strings.NewReader("{\n  \"task_id\": \"<string>\",\n  \"content\": {\n    \"content\": \"<string>\",\n    \"type\": \"text\",\n    \"style\": \"static\",\n    \"format\": \"plain\",\n    \"attachments\": [\n      {\n        \"file_id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"size\": 123,\n        \"type\": \"<string>\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.example.com/messages/{message_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"task_id\": \"<string>\",\n  \"content\": {\n    \"content\": \"<string>\",\n    \"type\": \"text\",\n    \"style\": \"static\",\n    \"format\": \"plain\",\n    \"attachments\": [\n      {\n        \"file_id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"size\": 123,\n        \"type\": \"<string>\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/messages/{message_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"task_id\": \"<string>\",\n  \"content\": {\n    \"content\": \"<string>\",\n    \"type\": \"text\",\n    \"style\": \"static\",\n    \"format\": \"plain\",\n    \"attachments\": [\n      {\n        \"file_id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"size\": 123,\n        \"type\": \"<string>\"\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "task_id": "<string>",
  "content": {
    "author": "user",
    "content": "<string>",
    "type": "text",
    "style": "static",
    "format": "plain",
    "attachments": [
      {
        "file_id": "<string>",
        "name": "<string>",
        "size": 123,
        "type": "<string>"
      }
    ]
  },
  "id": "<string>",
  "streaming_status": "IN_PROGRESS",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

PUT

messages

{message_id}

Update Message

curl --request PUT \
  --url https://api.example.com/messages/{message_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "task_id": "<string>",
  "content": {
    "content": "<string>",
    "type": "text",
    "style": "static",
    "format": "plain",
    "attachments": [
      {
        "file_id": "<string>",
        "name": "<string>",
        "size": 123,
        "type": "<string>"
      }
    ]
  }
}
'

import requests

url = "https://api.example.com/messages/{message_id}"

payload = {
    "task_id": "<string>",
    "content": {
        "content": "<string>",
        "type": "text",
        "style": "static",
        "format": "plain",
        "attachments": [
            {
                "file_id": "<string>",
                "name": "<string>",
                "size": 123,
                "type": "<string>"
            }
        ]
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    task_id: '<string>',
    content: {
      content: '<string>',
      type: 'text',
      style: 'static',
      format: 'plain',
      attachments: [{file_id: '<string>', name: '<string>', size: 123, type: '<string>'}]
    }
  })
};

fetch('https://api.example.com/messages/{message_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/messages/{message_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'task_id' => '<string>',
    'content' => [
        'content' => '<string>',
        'type' => 'text',
        'style' => 'static',
        'format' => 'plain',
        'attachments' => [
                [
                                'file_id' => '<string>',
                                'name' => '<string>',
                                'size' => 123,
                                'type' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/messages/{message_id}"

	payload := strings.NewReader("{\n  \"task_id\": \"<string>\",\n  \"content\": {\n    \"content\": \"<string>\",\n    \"type\": \"text\",\n    \"style\": \"static\",\n    \"format\": \"plain\",\n    \"attachments\": [\n      {\n        \"file_id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"size\": 123,\n        \"type\": \"<string>\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.example.com/messages/{message_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"task_id\": \"<string>\",\n  \"content\": {\n    \"content\": \"<string>\",\n    \"type\": \"text\",\n    \"style\": \"static\",\n    \"format\": \"plain\",\n    \"attachments\": [\n      {\n        \"file_id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"size\": 123,\n        \"type\": \"<string>\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/messages/{message_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"task_id\": \"<string>\",\n  \"content\": {\n    \"content\": \"<string>\",\n    \"type\": \"text\",\n    \"style\": \"static\",\n    \"format\": \"plain\",\n    \"attachments\": [\n      {\n        \"file_id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"size\": 123,\n        \"type\": \"<string>\"\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "task_id": "<string>",
  "content": {
    "author": "user",
    "content": "<string>",
    "type": "text",
    "style": "static",
    "format": "plain",
    "attachments": [
      {
        "file_id": "<string>",
        "name": "<string>",
        "size": 123,
        "type": "<string>"
      }
    ]
  },
  "id": "<string>",
  "streaming_status": "IN_PROGRESS",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

message_id

string

required

Body

application/json

task_id

string

required

content

TextContent · object

required

TextContent
ReasoningContent
DataContent
ToolRequestContent
ToolResponseContent

Show child attributes

streaming_status

enum<string> | null

Available options:

IN_PROGRESS,

DONE

Response

Successful Response

Represents a message in the agent system.

This entity is used to store messages in MongoDB, with each message associated with a specific task.

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.

TextContent
ReasoningContent
DataContent
ToolRequestContent
ToolResponseContent

Show child attributes

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

Agents

Tasks

Messages

Spans

States

Events

Agent Task Tracker

Agent APIKeys

Deployment History

Deployments

Schedules

Checkpoints

task-retention

Update Message

Path Parameters

Body

Response