SparQDocs
GuidesAPI referencesparqhq.ai
API referenceChanges

List Drafts

GET
/v1/admin/projects/{project_id}/drafts

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.

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

project_id*Project 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.

sort?|

Field to sort by; '-' for descending. Ties break on the id.

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/admin/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/drafts'
Example Response
{  "next_cursor": "string",  "total": 0,  "items": [    {      "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",      "kind": "agent",      "name": "string",      "base_version": "1.4.0",      "document": {        "kind": "agent",        "schema_version": "1",        "name": "string",        "version": "1.4.0",        "job": "string",        "routing_description": "string",        "who_can_use": [          "agent"        ],        "mode": "react",        "escalate_to": "react",        "model": {          "class": "fast",          "fallback_class": "fast",          "reasoning_effort": "low"        },        "instructions": "string",        "output_schema": "string",        "skills": [          "refund-policy@^1"        ],        "tools": [          "tickets.get"        ],        "agents": [          "refund-policy@^1"        ],        "workflow": "refund-policy@^1",        "limits": {          "model_requests": 25,          "tool_calls": 15,          "delegation_depth": 2,          "loop_iterations": 3,          "interactive_wall_clock_s": 120,          "background_wall_clock_s": 1800        },        "approvals": {          "autonomy": "read_only",          "ask_before": [            "read"          ],          "plan_check": true,          "pause_timeout_s": 86400        },        "features_required": [          "web_search"        ],        "middleware": [          "string"        ],        "tests": {          "suite": "string",          "must_pass": 0,          "leaks_allowed": 0        },        "knowledge": {          "collections": [            "string"          ],          "top_k": 8,          "min_score": 0.3,          "citations_required": true        }      },      "content_hash": "string",      "status": "draft",      "created_by": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}

List Change Requests 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 Releases 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.