Passer au contenu principal
POST
/
agent-sessions
/
{session_id}
/
navigate-to-checkpoint
Naviguer vers un point de contrôle
import requests

url = "https://app.ubik-agent.com/api/v1/agent-sessions/{session_id}/navigate-to-checkpoint"

payload = {
    "checkpoint_name": "<string>",
    "checkpoint_hint": "<string>",
    "stream": True
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({checkpoint_name: '<string>', checkpoint_hint: '<string>', stream: true})
};

fetch('https://app.ubik-agent.com/api/v1/agent-sessions/{session_id}/navigate-to-checkpoint', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
curl --request POST \
--url https://app.ubik-agent.com/api/v1/agent-sessions/{session_id}/navigate-to-checkpoint \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"checkpoint_name": "<string>",
"checkpoint_hint": "<string>",
"stream": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": "<string>",
  "content": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sibling_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "task_id": "<string>",
  "stream_url": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Autorisations

X-API-KEY
string
header
requis

En-têtes

X-End-User-ID
string | null

Paramètres de chemin

session_id
string<uuid>
requis

Corps

application/json
checkpoint_name
string
requis

The name of the checkpoint to navigate to.

checkpoint_hint
string | null

Optional hint to guide the agent when resuming from this checkpoint.

stream
boolean
défaut:true

Whether to stream the response.

Réponse

Successful Response

id
string<uuid>
requis

Unique identifier for the message.

role
string
requis

Role of the message sender (user, assistant, system).

content
string
requis

Content of the message.

created_at
string<date-time>
requis

Creation timestamp.

parent_id
string<uuid> | null

ID of the parent message.

sibling_ids
string<uuid>[]

IDs of other messages that share the same parent (branches).

task_id
string | null

The ID of the task processing this message (if applicable).

stream_url
string | null

URL to stream events for this task.