Steer
Pause a session
Pause a running session and keep its state for a later resume.
POST
/
api
/
v2
/
sessions
/
{id}
/
pause
from hai_agents import Client
client = Client()
client.sessions.pause_session(session_id)
import { HaiAgentsClient } from "hai-agents";
const client = new HaiAgentsClient();
await client.sessions.pauseSession({ id: sessionId });
curl -X POST https://agp.eu.hcompany.ai/api/v2/sessions/$SESSION_ID/pause \
-H "Authorization: Bearer $HAI_API_KEY"
Path parameters
string
required
The session ID.
Response
202 Accepted. The command is delivered asynchronously.
from hai_agents import Client
client = Client()
client.sessions.pause_session(session_id)
import { HaiAgentsClient } from "hai-agents";
const client = new HaiAgentsClient();
await client.sessions.pauseSession({ id: sessionId });
curl -X POST https://agp.eu.hcompany.ai/api/v2/sessions/$SESSION_ID/pause \
-H "Authorization: Bearer $HAI_API_KEY"
Errors
| Status | Cause |
|---|---|
404 | Not found, or not in your organization. |
409 | The session is queued (nothing is running yet) or already finished. |
Was this page helpful?
⌘I
from hai_agents import Client
client = Client()
client.sessions.pause_session(session_id)
import { HaiAgentsClient } from "hai-agents";
const client = new HaiAgentsClient();
await client.sessions.pauseSession({ id: sessionId });
curl -X POST https://agp.eu.hcompany.ai/api/v2/sessions/$SESSION_ID/pause \
-H "Authorization: Bearer $HAI_API_KEY"