Sessions

List sessions

Returns sessions the caller can access, optionally filtered by agent, actor and status.

get/v1/projects/{project_id}/sessions

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/sessions
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Query parameters

agent_idstring
Example:agent_V1StGXR8Z5jdHi6B

Filter by agent public ID

actor_idstring

Filter by actor public ID

statusstring[]

Filter by session status. Repeat the parameter to OR values. A value outside the enum, empty string included, is a 400.

tagsstring[]

Filter by tag pairs, written key:value (split on the first colon, so a value may contain colons). Repeat the parameter for several pairs; all must be present with exactly that value.

limitinteger

Results per page, 1 to 100 (default 50). Above 100 it is clamped; below 1 or not an integer it is 400.

offsetinteger

Results to skip. Negative or not an integer it is 400.

Response

Paginated list of sessions

totalinteger
limitinteger
offsetinteger

Example response

{
  "data": [
    {
      "id": "sess_V1StGXR8Z5jdHi6B",
      "agent_id": "agent_V1StGXR8Z5jdHi6B",
      "conversation_id": "conv_V1StGXR8Z5jdHi6B",
      "status": "open",
      "name": "Support chat",
      "actor_id": "actor_V1StGXR8Z5jdHi6B",
      "tags": {
        "team": "finance",
        "env": "prod"
      },
      "inactivity_ttl_seconds": 300,
      "message_delay_seconds": 3,
      "max_context_messages": 20,
      "forked_from_session_id": "sess_V1StGXR8Z5jdHi6B",
      "forked_from_position": 7
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.