SparQDocs
GuidesAPI referencesparqhq.ai
API referenceChanges

Validate Draft

POST
/v1/admin/drafts/{draft_id}/validate

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

draft_id*Draft Id
Formatuuid

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

Response Body

Successful Response

application/json
  1. response

Schema checks, references, limits, and instruction lint.

draft_id*Draft Id
Formatuuid
valid*Valid
issues*array<>
Example Request
curl -X POST 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/drafts/497f6eca-6276-4993-bfeb-53cbbbba6f08/validate'
Example Response
{  "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",  "valid": true,  "issues": [    {      "path": "string",      "code": "string",      "message": "string",      "severity": "error"    }  ]}

Update Draft 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.

Get Client Pack 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.