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
AgentSession beta().agents().sessions().create(params, requestOptions = RequestOptions.none())
POST
/agents/sessions
Delete an agent session
AgentSessionDeleted beta().agents().sessions().delete(params = SessionDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE
/agents/sessions/{session_id}
List agent sessions
SessionListPage beta().agents().sessions().list(params = SessionListParams.none(), requestOptions = RequestOptions.none())
GET
/agents/sessions
Retrieve an agent session
AgentSession beta().agents().sessions().retrieve(params = SessionRetrieveParams.none(), requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}
Update an agent session
AgentSession beta().agents().sessions().update(params = SessionUpdateParams.none(), requestOptions = RequestOptions.none())
POST
/agents/sessions/{session_id}

SessionsArtifacts

Retrieve agent session artifact content
HttpResponse beta().agents().sessions().artifacts().content(params, requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}/artifacts/{artifact_id}/content
Delete an agent session artifact
SessionArtifactDeleted beta().agents().sessions().artifacts().delete(params, requestOptions = RequestOptions.none())
DELETE
/agents/sessions/{session_id}/artifacts/{artifact_id}
List agent session artifacts
ArtifactListPage beta().agents().sessions().artifacts().list(params = ArtifactListParams.none(), requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}/artifacts
Retrieve an agent session artifact
SessionArtifact beta().agents().sessions().artifacts().retrieve(params, requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}/artifacts/{artifact_id}
Models
class SessionArtifact:

An immutable file published by a completed hosted session turn.

class SessionArtifactDeleted:

Confirmation that an immutable session artifact was deleted.

SessionsEvents

Create agent session input events
beta().agents().sessions().events().create(params, requestOptions = RequestOptions.none())
POST
/agents/sessions/{session_id}/events
Stream agent session events
AgentSessionEvent beta().agents().sessions().events().streamStreaming(params = EventStreamParams.none(), requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}/events

SessionsItems

List agent session items
ItemListPage beta().agents().sessions().items().list(params = ItemListParams.none(), requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}/items

SessionsSubagents

List session subagents
SubagentListPage beta().agents().sessions().subagents().list(params = SubagentListParams.none(), requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}/subagents
Retrieve a session subagent
Subagent beta().agents().sessions().subagents().retrieve(params, requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}/subagents/{subagent_id}

SessionsSubagentsItems

List subagent items
ItemListPage beta().agents().sessions().subagents().items().list(params, requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}/subagents/{subagent_id}/items

SessionsSubagentsTurns

List subagent turns
TurnListPage beta().agents().sessions().subagents().turns().list(params, requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}/subagents/{subagent_id}/turns
Retrieve a subagent turn
Turn beta().agents().sessions().subagents().turns().retrieve(params, requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}

SessionsSubagentsTurnsItems

List subagent turn items
ItemListPage beta().agents().sessions().subagents().turns().items().list(params, requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}/items

SessionsTraces

List agent session traces
TraceListPage beta().agents().sessions().traces().list(params = TraceListParams.none(), requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}/traces
Models
class SessionTrace:

SessionsTurns

List agent session turns
TurnListPage beta().agents().sessions().turns().list(params = TurnListParams.none(), requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}/turns
Retrieve an agent session turn
Turn beta().agents().sessions().turns().retrieve(params, requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}/turns/{turn_id}
Models
class Turn:

The canonical public representation of a session turn.

SessionsTurnsItems

List agent session turn items
ItemListPage beta().agents().sessions().turns().items().list(params, requestOptions = RequestOptions.none())
GET
/agents/sessions/{session_id}/turns/{turn_id}/items