Beta APIs

[beta] Stream voice agent session summaries

Returns a paginated stream of voice agent session summaries, filterable by start time, agent, vehicle, driver, and status. Sessions are returned ordered by happenedAtTime descending (most recent first). Use this endpoint to discover sessions; pass the returned IDs to GET /agent-studio/voice-sessions to fetch full session details.

<b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Read Agent Studio Voice Sessions under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

get/agent-studio/voice-sessions/stream

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Query parameters

startTimestring required

Lower bound on session start time, in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2026-05-19T14:23:11Z, 2026-05-19T14:23:11.455Z, OR 2026-05-19T10:23:11-04:00).

endTimestring

Upper bound on session start time, in RFC 3339 format. Defaults to the current time when omitted. Millisecond precision and timezones are supported.

agentIdsstring[] required

Required, comma-separated list of Agent Studio agent IDs to filter sessions on. Up to 100 agent IDs per call.

vehicleIdsstring[]

Optional, comma-separated list of vehicle IDs. When set, only sessions whose target device was associated with one of these vehicles are returned. Up to 100 vehicle IDs per call.

driverIdsstring[]

Optional, comma-separated list of driver IDs. When set, only sessions whose target device was associated with one of these drivers are returned. Up to 100 driver IDs per call.

sessionStatusstring[]

Optional, comma-separated list of session statuses to filter on. Valid values: completed, running, failed, unknown. Defaults to completed when omitted.

afterstring

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

limitinteger

Maximum number of sessions to return. Default 50, max 100.

Response

OK response.

Example response

{
  "data": [
    {
      "agentId": "agt_01HX0000000000000000000001",
      "agentName": "Pole Yard Intake",
      "durationMilliseconds": 87420,
      "happenedAtTime": "2026-05-19T14:23:11Z",
      "id": "ses_01HX9Z7VKQ8N3B2YQ1F4E5R6T7",
      "recipient": "Driver Bob",
      "sessionStatus": "completed",
      "triggerType": "geofence",
      "updatedAtTime": "2026-05-19T14:24:38Z"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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