Agent

Create agent session

Changed on

Create a new agent session, optionally linked to a persona.

post/api/v0/agent/sessions

Request

Request body

namestring nullable

Optional name for the session.

persona_idstring uuid nullable

Optional persona ID. The persona defines the agent's prompt, tools, and knowledge bases. When null, uses the default persona.

Response

Successful Response

idstring uuid required

The ID of the session.

persona_idstring uuid nullable

The ID of the persona used by this session. Null means default persona.

namestring nullable required

The name of the session.

statusstring required

The status of the session. Options: 'active', 'completed', 'error'.

message_countinteger required

The number of messages in the session.

is_roamingboolean

True iff this session's persona exposes any fs_* / fs_bash tool and therefore has a workspace directory the agent reads/writes.

section_idstring uuid nullable

The chat history section this session is filed under; null when it is in none.

created_atstring date-time required

When the session was created.

updated_atstring date-time required

When the session was last updated.

Changes

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status