Skip to main content
POST
/
tasks
/
{task_id}
/
rehydrate
Rehydrate Task
curl --request POST \
  --url https://api.example.com/tasks/{task_id}/rehydrate \
  --header 'Content-Type: application/json' \
  --data '
{
  "task_id": "<string>",
  "messages": [
    {
      "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"
    }
  ],
  "task_states": [
    {
      "task_id": "<string>",
      "agent_id": "<string>",
      "state": {},
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "snapshot_url": "<string>"
}
'
import requests

url = "https://api.example.com/tasks/{task_id}/rehydrate"

payload = {
    "task_id": "<string>",
    "messages": [
        {
            "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"
        }
    ],
    "task_states": [
        {
            "task_id": "<string>",
            "agent_id": "<string>",
            "state": {},
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
        }
    ],
    "snapshot_url": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    task_id: '<string>',
    messages: [
      {
        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'
      }
    ],
    task_states: [
      {
        task_id: '<string>',
        agent_id: '<string>',
        state: {},
        id: '<string>',
        created_at: '2023-11-07T05:31:56Z',
        updated_at: '2023-11-07T05:31:56Z'
      }
    ],
    snapshot_url: '<string>'
  })
};

fetch('https://api.example.com/tasks/{task_id}/rehydrate', 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/tasks/{task_id}/rehydrate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'task_id' => '<string>',
    'messages' => [
        [
                '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'
        ]
    ],
    'task_states' => [
        [
                'task_id' => '<string>',
                'agent_id' => '<string>',
                'state' => [
                                
                ],
                'id' => '<string>',
                'created_at' => '2023-11-07T05:31:56Z',
                'updated_at' => '2023-11-07T05:31:56Z'
        ]
    ],
    'snapshot_url' => '<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/tasks/{task_id}/rehydrate"

	payload := strings.NewReader("{\n  \"task_id\": \"<string>\",\n  \"messages\": [\n    {\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      \"id\": \"<string>\",\n      \"created_at\": \"2023-11-07T05:31:56Z\",\n      \"updated_at\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"task_states\": [\n    {\n      \"task_id\": \"<string>\",\n      \"agent_id\": \"<string>\",\n      \"state\": {},\n      \"id\": \"<string>\",\n      \"created_at\": \"2023-11-07T05:31:56Z\",\n      \"updated_at\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"snapshot_url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.example.com/tasks/{task_id}/rehydrate")
  .header("Content-Type", "application/json")
  .body("{\n  \"task_id\": \"<string>\",\n  \"messages\": [\n    {\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      \"id\": \"<string>\",\n      \"created_at\": \"2023-11-07T05:31:56Z\",\n      \"updated_at\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"task_states\": [\n    {\n      \"task_id\": \"<string>\",\n      \"agent_id\": \"<string>\",\n      \"state\": {},\n      \"id\": \"<string>\",\n      \"created_at\": \"2023-11-07T05:31:56Z\",\n      \"updated_at\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"snapshot_url\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/tasks/{task_id}/rehydrate")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"task_id\": \"<string>\",\n  \"messages\": [\n    {\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      \"id\": \"<string>\",\n      \"created_at\": \"2023-11-07T05:31:56Z\",\n      \"updated_at\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"task_states\": [\n    {\n      \"task_id\": \"<string>\",\n      \"agent_id\": \"<string>\",\n      \"state\": {},\n      \"id\": \"<string>\",\n      \"created_at\": \"2023-11-07T05:31:56Z\",\n      \"updated_at\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"snapshot_url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

​
task_id
string
required

Body

application/json

Either provide inline content (messages + task_states) or a snapshot_url pointing at a presigned JSON download. Mixing both is rejected.

The inline form is the canonical shape used by export's GET response, so snapshot → clean → rehydrate round-trips cleanly without serialization changes.

​
task_id
string
required
​
messages
TaskMessageEntity · object[]
​
task_states
StateEntity · object[]
​
snapshot_url
string<uri> | null

Presigned GET URL whose body is a JSON-encoded TaskSnapshotEntity. Must be https; must resolve to a public address. When set, messages/task_states must be empty.

Required string length: 1 - 2083

Response

Successful Response