SparQDocs
GuidesAPI referencesparqhq.ai
API referenceRuns

List Approvals

GET
/v1/approvals

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.

Approvals the caller may decide, in their scope.

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.

Query Parameters

limit?Limit

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

Range1 <= value <= 200
Default50
cursor?|

Opaque next_cursor from the previous page.

status?|null
since?|null
until?|null

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/approvals'
Example Response
{  "next_cursor": "string",  "total": 0,  "items": [    {      "approval_id": "15af2260-72db-4fc4-b587-6b841d6a3d55",      "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",      "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",      "tool": "tickets.get",      "effect": "read",      "summary": "string",      "status": "pending",      "requested_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z",      "invocation_id": "9efe53a2-0f4e-415e-a218-b405e1367798",      "arguments_hash": "string"    }  ]}

Get Run 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.

Stream Run 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. Follow a run's stream, for example after a reconnect or after a pause is answered.