Skip to main content
POST
/
agent-sessions
/
{session_id}
/
navigate-to-checkpoint
Navigate to checkpoint
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)
{
  "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>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.ubik-agent.com/llms.txt

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

Authorizations

​
X-API-KEY
string
header
required

Headers

​
X-End-User-ID
string | null

Path Parameters

​
session_id
string<uuid>
required

Body

application/json
​
checkpoint_name
string
required

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
default:true

Whether to stream the response.

Response

Successful Response

​
id
string<uuid>
required

Unique identifier for the message.

​
role
string
required

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

​
content
string
required

Content of the message.

​
created_at
string<date-time>
required

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.