Get Session

curl --request GET \
  --url https://api.mixpeek.com/v1/agents/sessions/{session_id}

{
  "session_id": "<string>",
  "namespace_id": "<string>",
  "internal_id": "<string>",
  "agent_config": {
    "model": "gpt-4o-mini",
    "temperature": 0.7,
    "max_tokens": 4096,
    "system_prompt": "You are a helpful AI assistant with access to Mixpeek's data infrastructure.",
    "available_tools": [
      "<string>"
    ]
  },
  "status": "active",
  "message_count": 123,
  "stats": {
    "total_messages": 0,
    "total_tokens": 0,
    "total_tool_calls": 0,
    "avg_latency_ms": 0
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_activity_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "user_id": "<string>",
  "session_name": "<string>",
  "user_memory": {}
}

Agent Sessions

Get Session

Get session metadata by ID.

Args: request: FastAPI request with tenant context session_id: Session identifier

Returns: GetSessionResponse with session metadata

Raises: NotFoundError: If session not found

Example:

curl -X GET http://localhost:8000/v1/agents/sessions/ses_abc123 \
  -H "Authorization: Bearer {api_key}" \
  -H "X-Namespace: {namespace_id}"

GET

agents

sessions

{session_id}

Get Session

curl --request GET \
  --url https://api.mixpeek.com/v1/agents/sessions/{session_id}

{
  "session_id": "<string>",
  "namespace_id": "<string>",
  "internal_id": "<string>",
  "agent_config": {
    "model": "gpt-4o-mini",
    "temperature": 0.7,
    "max_tokens": 4096,
    "system_prompt": "You are a helpful AI assistant with access to Mixpeek's data infrastructure.",
    "available_tools": [
      "<string>"
    ]
  },
  "status": "active",
  "message_count": 123,
  "stats": {
    "total_messages": 0,
    "total_tokens": 0,
    "total_tool_calls": 0,
    "avg_latency_ms": 0
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_activity_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "user_id": "<string>",
  "session_name": "<string>",
  "user_memory": {}
}

Headers

Authorization

string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

X-Namespace

string

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Path Parameters

session_id

string

required

Session ID

Response

Successful Response

Response for retrieving session metadata.

Attributes: session_id: Session identifier namespace_id: Namespace identifier internal_id: Organization internal ID user_id: Optional user identifier session_name: Auto-generated session name (null until first message) agent_config: Agent configuration user_memory: User memory/preferences status: Session status message_count: Total messages in session stats: Session statistics created_at: Creation timestamp updated_at: Last update timestamp last_activity_at: Last activity timestamp expires_at: Expiration timestamp

Example: python response = GetSessionResponse( session_id="ses_abc123", namespace_id="ns_xyz789", internal_id="int_abc123", session_name="Video search for ML tutorials", agent_config=AgentConfig(...), status="active", message_count=10, stats=SessionStats(...) )

session_id

string

required

Session identifier

namespace_id

string

required

Namespace identifier

internal_id

string

required

Organization internal ID

agent_config

AgentConfig · object

required

Agent configuration

Show child attributes

agent_config.model

string

default:gpt-4o-mini

LLM model identifier. Options: 'gpt-4o-mini' (fastest), 'gpt-4o' (recommended), 'claude-3-5-sonnet-20241022', 'claude-3-haiku-20240307'

agent_config.temperature

number

default:0.7

Sampling temperature for LLM responses (0.0-2.0). Lower values (0.0-0.3) are more deterministic. Higher values (0.8-2.0) are more creative.

Required range: 0 <= x <= 2

agent_config.max_tokens

integer

default:4096

Maximum tokens per response

Required range: 1 <= x <= 100000

agent_config.system_prompt

string

default:You are a helpful AI assistant with access to Mixpeek's data infrastructure.

System prompt that defines agent behavior and persona

agent_config.available_tools

string[]

List of tool names the agent can call. Available tools: RETRIEVER: list_retrievers, get_retriever, explain_retriever, execute_retriever, search_retrievers. COLLECTION: list_collections, get_collection, create_collection, update_collection, delete_collection. TAXONOMY: list_taxonomies, get_taxonomy, create_taxonomy, update_taxonomy, delete_taxonomy. REGISTRY: list_stages, list_extractors. INGEST: ingest_document. CLUSTER: list_clusters. OBJECT: get_object.

status

enum<string>

required

Session status

Available options:

active,

idle,

archived,

terminated

message_count

integer

required

Total messages in session

stats

SessionStats · object

required

Session statistics

Show child attributes

stats.total_messages

integer

default:0

Total messages sent in session

Required range: x >= 0

stats.total_tokens

integer

default:0

Cumulative tokens used (for cost tracking)

Required range: x >= 0

stats.total_tool_calls

integer

default:0

Total tool invocations

Required range: x >= 0

stats.avg_latency_ms

number

default:0

Average message latency in milliseconds

Required range: x >= 0

created_at

string<date-time>

required

Creation timestamp

updated_at

string<date-time>

required

Last update timestamp

last_activity_at

string<date-time>

required

Last activity timestamp

expires_at

string<date-time>

required

Expiration timestamp

user_id

string | null

User identifier

session_name

string | null

Auto-generated session name based on first conversation

user_memory

User Memory · object

User memory/preferences

List Sessions Terminate Session

⌘I

Health

Organizations

Namespaces

Buckets

Feature Extractors

Collections

Retrievers

Taxonomies

Clusters

Templates

Analytics

Resource Search

Inference

Agent Sessions

Tasks

Webhooks

Notifications

Triggers

Get Session

Headers

Path Parameters

Response