SparQDocs
GuidesAPI referencesparqhq.ai
API referenceSessions

List Messages

GET
/v1/sessions/{session_id}/messages

Not available yet. This operation is part of the published contract and answers 501 not_implemented until it is built. The request and response shapes below are final for this contract version.

Only for the session's own user. Tenant admins never read message content; operators only through audited break-glass.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Bearer credential. API keys look like sqk_<geo>_<key_id>_<secret>: treat them as opaque and never put one in a browser. Older keys without the geo part stay valid until rotated. Find a geo's endpoints through GET /.well-known/sparq-discovery before sending a key.

Path Parameters

session_id*Session Id
Formatuuid

Query Parameters

limit?Limit

Items per page (default 50, at most 200).

Range1 <= value <= 200
Default50
cursor?|

Opaque next_cursor from the previous page.

Header Parameters

Sparq-Workspace?string

For a person signed in to a console with several workspaces: the workspace this call is for, one of their memberships (listMyMemberships). Without it such a person gets workspace_required (400); a workspace they are not a member of is forbidden. It never grants anything, and other callers' credentials ignore it.

Formatuuid

Response Body

Successful Response

application/json
  1. response
next_cursor*|

Pass as cursor for the next page; empty at the end.

total?|

Number of matching items, only when cheap to count.

items*array<>
Example Request
curl -X GET 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/messages'
Example Response
{  "next_cursor": "string",  "total": 0,  "items": [    {      "message_id": "d7d9d9fd-478f-40e6-b651-49b7f19878a2",      "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",      "role": "user",      "content": "string",      "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",      "created_at": "2019-08-24T14:15:22Z"    }  ]}

Get Session GET

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version.

List Sessions GET

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version. The caller's own sessions.