Skip to main content
GET
/
v1
/
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": "gemini-2.0-flash",
    "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.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

​
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'

Examples:

"ns_abc123def456"

"production"

"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

Examples:
{
  "available_tools": [
    "list_retrievers",
    "get_retriever",
    "execute_retriever",
    "list_collections",
    "get_collection"
  ],
  "max_tokens": 4096,
  "model": "claude-3-5-sonnet-20241022",
  "system_prompt": "You are a video analysis assistant that helps users find and analyze video content.",
  "temperature": 0.7
}
{
  "available_tools": ["list_retrievers", "execute_retriever"],
  "max_tokens": 2048,
  "model": "claude-3-haiku-20240307",
  "system_prompt": "You are a quick search assistant. Be concise.",
  "temperature": 0.3
}
​
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

​
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