SparQDocs
GuidesAPI referencesparqhq.ai
API referenceSessions

Create Session

POST
/v1/sessions

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.

Start a conversation with an agent, or with auto to let the router choose.

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.

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
Idempotency-Key?string

Makes a retry safe: the same key, route and body within 24 hours returns the stored response and the same result id. The same key with a different body or route is idempotency_conflict; while the first request runs, idempotency_in_progress.

Length8 <= length <= 128

Request Body

application/json
  1. body

Body of POST /v1/sessions.

agent*Agent

Agent name, or 'auto' to let the router choose.

Match^[a-z][a-z0-9_-]{0,62}$
context_hints?

Untrusted hints for the host's context resolver.

features?

Conversation-level switches; refused if not allowed.

Response Body

Successful Response

application/json
  1. response
session_id*Session Id
Formatuuid
project_id*Project Id
Formatuuid
audience_tenant_id*Audience Tenant Id

The customer tenant, or the project's reserved tenant.

Formatuuid
agent*Agent

Lower-case name: a letter, then letters, digits, '_' or '-'. Max 63.

Match^[a-z][a-z0-9_-]{0,62}$
created_at*Created At
Formatdate-time
credential_id*Credential Id
Formatuuid
Example Request
curl -X POST 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/sessions' \  -H 'Content-Type: application/json' \  -d '{  "agent": "string"}'
Example Response
{  "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",  "audience_tenant_id": "0287c3f7-886a-49f4-a73e-03577e798c26",  "agent": "string",  "created_at": "2019-08-24T14:15:22Z",  "credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242"}

Set Kill Switch PUT

> **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. Stops new and running work for the target within 30 seconds; audited.

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.