Skip to main content
POST
Create Session

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request payload for creating a new agent session.

Attributes: agent_config: Agent configuration (model, temperature, tools, etc.) quotas: Optional session quotas and rate limits user_id: Optional user identifier user_memory: Optional initial user memory/preferences metadata: Optional session metadata

Example: python request = CreateSessionRequest( agent_config=AgentConfig( model="claude-3-5-sonnet-20241022", temperature=0.7, available_tools=["search_retrievers", "execute_retriever"] ), quotas=SessionQuotas( max_messages=100, max_tokens_total=100000 ), user_id="user_123", user_memory={"preferences": {"language": "en"}} )

agent_config
AgentConfig · object
required

Agent configuration (REQUIRED)

Examples:
quotas
SessionQuotas · object | null

Session quotas and rate limits (OPTIONAL)

Example:
user_id
string | null

User identifier (OPTIONAL)

user_memory
User Memory · object

Initial user memory/preferences (OPTIONAL)

metadata
Metadata · object

Session metadata (OPTIONAL)

enable_memory
boolean
default:true

Enable semantic memory for conversation context (OPTIONAL, default: True)

Response

Successful Response

Response for session creation.

Attributes: session_id: Unique session identifier namespace_id: Namespace identifier internal_id: Organization internal ID session_name: Auto-generated session name (null until first message) status: Session status created_at: Session creation timestamp expires_at: Session expiration timestamp

Example: python response = CreateSessionResponse( session_id="ses_abc123", namespace_id="ns_xyz789", internal_id="int_abc123", session_name=None, # Will be set after first message status="active", created_at=current_time(), expires_at=current_time() + timedelta(days=7) )

session_id
string
required

Unique session identifier

namespace_id
string
required

Namespace identifier

internal_id
string
required

Organization internal ID

status
enum<string>
required

Session status

Available options:
active,
idle,
archived,
terminated
created_at
string<date-time>
required

Session creation timestamp

expires_at
string<date-time>
required

Session expiration timestamp

session_name
string | null

Auto-generated session name based on first conversation (set after first message)