SparQDocs
GuidesAPI referencesparqhq.ai
API referenceCompliance

Get Client Pack

GET
/v1/admin/audience-tenants/{audience_tenant_id}/client-pack

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

audience_tenant_id*Audience Tenant 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

Response Body

Successful Response

application/json
  1. response
kind?Kind
Default"client_pack"
schema_version?Schema Version
Default"1"
audience_tenant_id*Audience Tenant Id
Formatuuid
version*Version
Range1 <= value
vocabulary?array<>
Itemsitems <= 500
instructions?Instructions

Extra instructions for this client. Linted like any instruction text.

Lengthlength <= 4000
Default""
knowledge_collections?array<>
features?

Feature switches at audience-tenant level, within the project's limits.

compliance_profile_version?|

The compliance profile version this pack was checked with.

Example Request
curl -X GET 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/audience-tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/client-pack'
Example Response
{  "kind": "client_pack",  "schema_version": "1",  "audience_tenant_id": "0287c3f7-886a-49f4-a73e-03577e798c26",  "version": 1,  "vocabulary": [    {      "term": "string",      "meaning": "string"    }  ],  "instructions": "",  "knowledge_collections": [    "string"  ],  "features": {},  "compliance_profile_version": 1}

Validate Draft POST

> **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 Compliance Profile GET

The client's current profile. Without one, routing applies the defaults (any region, nothing above `internal` to external models) and this answers 404.