Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation
Theme

Sessions

Create an agent session
beta.agents.sessions.create(**kwargs) -> AgentSession { id, agent, created_at, 12 more }
POST
/agents/sessions
Delete an agent session
beta.agents.sessions.delete(session_id) -> AgentSessionDeleted { id, deleted, object }
DELETE
/agents/sessions/{session_id}
List agent sessions
beta.agents.sessions.list(**kwargs) -> CursorPage<AgentSession { id, agent, created_at, 12 more } >
GET
/agents/sessions
Retrieve an agent session
beta.agents.sessions.retrieve(session_id) -> AgentSession { id, agent, created_at, 12 more }
GET
/agents/sessions/{session_id}
Update an agent session
beta.agents.sessions.update(session_id, **kwargs) -> AgentSession { id, agent, created_at, 12 more }
POST
/agents/sessions/{session_id}

SessionsArtifacts

Retrieve agent session artifact content
beta.agents.sessions.artifacts.content(artifact_id, **kwargs) -> StringIO
GET
/agents/sessions/{session_id}/artifacts/{artifact_id}/content
Delete an agent session artifact
beta.agents.sessions.artifacts.delete(artifact_id, **kwargs) -> SessionArtifactDeleted { id, deleted, object }
DELETE
/agents/sessions/{session_id}/artifacts/{artifact_id}
List agent session artifacts
beta.agents.sessions.artifacts.list(session_id, **kwargs) -> CursorPage<SessionArtifact { id, created_at, environment_id, 5 more } >
GET
/agents/sessions/{session_id}/artifacts
Retrieve an agent session artifact
beta.agents.sessions.artifacts.retrieve(artifact_id, **kwargs) -> SessionArtifact { id, created_at, environment_id, 5 more }
GET
/agents/sessions/{session_id}/artifacts/{artifact_id}
Models
class SessionArtifact { id, created_at, environment_id, 5 more }

An immutable file published by a completed hosted session turn.

class SessionArtifactDeleted { id, deleted, object }

Confirmation that an immutable session artifact was deleted.

SessionsEvents

Create agent session input events
beta.agents.sessions.events.create(session_id, **kwargs) -> void
POST
/agents/sessions/{session_id}/events
Stream agent session events
beta.agents.sessions.events.stream(session_id, **kwargs) -> AgentSessionEvent
GET
/agents/sessions/{session_id}/events

SessionsItems

List agent session items
beta.agents.sessions.items.list(session_id, **kwargs) -> CursorPage<AgentSessionItem>
GET
/agents/sessions/{session_id}/items

SessionsSubagents

List session subagents
beta.agents.sessions.subagents.list(session_id, **kwargs) -> CursorPage<Subagent { id, closed_at, instructions, 6 more } >
GET
/agents/sessions/{session_id}/subagents
Retrieve a session subagent
beta.agents.sessions.subagents.retrieve(subagent_id, **kwargs) -> Subagent { id, closed_at, instructions, 6 more }
GET
/agents/sessions/{session_id}/subagents/{subagent_id}

SessionsSubagentsItems

List subagent items
beta.agents.sessions.subagents.items.list(subagent_id, **kwargs) -> CursorPage<AgentSessionItem>
GET
/agents/sessions/{session_id}/subagents/{subagent_id}/items

SessionsSubagentsTurns

List subagent turns
beta.agents.sessions.subagents.turns.list(subagent_id, **kwargs) -> CursorPage<Turn { id, agent_id, completed_at, 9 more } >
GET
/agents/sessions/{session_id}/subagents/{subagent_id}/turns
Retrieve a subagent turn
beta.agents.sessions.subagents.turns.retrieve(turn_id, **kwargs) -> Turn { id, agent_id, completed_at, 9 more }
GET
/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}

SessionsSubagentsTurnsItems

List subagent turn items
beta.agents.sessions.subagents.turns.items.list(turn_id, **kwargs) -> CursorPage<AgentSessionItem>
GET
/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}/items

SessionsTraces

List agent session traces
beta.agents.sessions.traces.list(session_id, **kwargs) -> CursorPage<SessionTrace { id, created_at, object, 2 more } >
GET
/agents/sessions/{session_id}/traces
Models
class SessionTrace { id, created_at, object, 2 more }

SessionsTurns

List agent session turns
beta.agents.sessions.turns.list(session_id, **kwargs) -> CursorPage<Turn { id, agent_id, completed_at, 9 more } >
GET
/agents/sessions/{session_id}/turns
Retrieve an agent session turn
beta.agents.sessions.turns.retrieve(turn_id, **kwargs) -> Turn { id, agent_id, completed_at, 9 more }
GET
/agents/sessions/{session_id}/turns/{turn_id}
Models
class Turn { id, agent_id, completed_at, 9 more }

The canonical public representation of a session turn.

SessionsTurnsItems

List agent session turn items
beta.agents.sessions.turns.items.list(turn_id, **kwargs) -> ConversationCursorPage<AgentSessionItem>
GET
/agents/sessions/{session_id}/turns/{turn_id}/items