List Sessions

curl --request POST \
  --url https://api.mixpeek.com/v1/agents/sessions/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "active",
  "filters": {},
  "sort": {}
}
'

{
  "sessions": [
    {
      "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": {}
    }
  ],
  "total": 123,
  "pagination": {}
}

Agent Sessions

List Sessions

List agent sessions in the namespace.

Args: request: FastAPI request with tenant context list_request: Optional filters and sorting pagination: Pagination parameters

Returns: ListSessionsResponse with session list

Example:

curl -X POST http://localhost:8000/v1/agents/sessions/list \
  -H "Authorization: Bearer {api_key}" \
  -H "X-Namespace: {namespace_id}" \
  -H "Content-Type: application/json" \
  -d '{"status": "active"}'

POST

agents

sessions

list

List Sessions

curl --request POST \
  --url https://api.mixpeek.com/v1/agents/sessions/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "active",
  "filters": {},
  "sort": {}
}
'

{
  "sessions": [
    {
      "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": {}
    }
  ],
  "total": 123,
  "pagination": {}
}

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'

Query Parameters

limit

integer | null

offset

integer | null

Body

application/json

Request payload for listing sessions.

Attributes: status: Optional status filter filters: Optional additional filters sort: Optional sort configuration

Example: python request = ListSessionsRequest( status="active", filters={"user_id": "user_123"} )

status

enum<string> | null

Filter by session status

Available options:

active,

idle,

archived,

terminated

filters

Filters · object

Additional filters

sort

Sort · object

Sort configuration

Response

Successful Response

Response for listing sessions.

Attributes: sessions: List of session summaries total: Total number of sessions matching query pagination: Pagination information

Example: python response = ListSessionsResponse( sessions=[...], total=50, pagination={...} )

sessions

GetSessionResponse · object[]

required

Session list

Show child attributes

sessions.session_id

string

required

Session identifier

sessions.namespace_id

string

required

Namespace identifier

sessions.internal_id

string

required

Organization internal ID

sessions.agent_config

AgentConfig · object

required

Agent configuration

Show child attributes

sessions.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'

sessions.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

sessions.agent_config.max_tokens

integer

default:4096

Maximum tokens per response

Required range: 1 <= x <= 100000

sessions.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

sessions.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.

sessions.status

enum<string>

required

Session status

Available options:

active,

idle,

archived,

terminated

sessions.message_count

integer

required

Total messages in session

sessions.stats

SessionStats · object

required

Session statistics

Show child attributes

sessions.stats.total_messages

integer

default:0

Total messages sent in session

Required range: x >= 0

sessions.stats.total_tokens

integer

default:0

Cumulative tokens used (for cost tracking)

Required range: x >= 0

sessions.stats.total_tool_calls

integer

default:0

Total tool invocations

Required range: x >= 0

sessions.stats.avg_latency_ms

number

default:0

Average message latency in milliseconds

Required range: x >= 0

sessions.created_at

string<date-time>

required

Creation timestamp

sessions.updated_at

string<date-time>

required

Last update timestamp

sessions.last_activity_at

string<date-time>

required

Last activity timestamp

sessions.expires_at

string<date-time>

required

Expiration timestamp

sessions.user_id

string | null

User identifier

sessions.session_name

string | null

Auto-generated session name based on first conversation

sessions.user_memory

User Memory · object

User memory/preferences

total

integer

required

Total matching sessions

pagination

Pagination · object

required

Pagination information

Create Session Get Session

⌘I

Health

Organizations

Namespaces

Buckets

Feature Extractors

Collections

Retrievers

Taxonomies

Clusters

Templates

Analytics

Resource Search

Inference

Agent Sessions

Tasks

Webhooks

Notifications

Triggers

List Sessions

Headers

Query Parameters

Body

Response