SparQDocs
GuidesAPI referencesparqhq.ai
API referenceCompliance

Put Compliance Profile

PUT
/v1/admin/audience-tenants/{audience_tenant_id}/compliance-profile

Replace the profile. version must be the current version plus one.

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
If-Match?string

The ETag you last read. A different current version is precondition_failed (412). Optional in 0.5.0.

Request Body

application/json
  1. body

One audience tenant's compliance rules. Versioned and audited; defaults from the project.

kind?Kind
Default"compliance_profile"
schema_version?Schema Version
Default"1"
audience_tenant_id*Audience Tenant Id
Formatuuid
version*Version

Increases by one on every change.

Range1 <= value
data_regions*array<>

Where prompts and outputs may be processed. ['any'] means unrestricted.

Items1 <= items
allowed_providers?array<>|

Narrower than the workspace list. Empty means the workspace's.

allowed_model_classes?array<>|null
provider_retention?ProviderRetention
Default"standard"
Value in"zero_retention_required""standard"
max_classification_to_external?DataClassification

Highest data class that may be sent to a model Sparq does not host itself.

Default"internal"
Value in"public""internal""confidential""restricted"
features_locked?

Features forced off (false) or on (true) for this client.

trace_content_policy?TraceContentPolicy

Highest level of prompt and response content allowed in trace destinations.

Default"off"
Value in"off""redacted""full"
retention_days?Retention Days
Range1 <= value <= 3650
Default180
approval_strictness?ApprovalStrictness
Default"standard"
Value in"standard""strict"
ai_use_restrictions?array<>

Contract clauses enforced as policy rules, in plain English.

Response Body

Successful Response

application/json
  1. response

One audience tenant's compliance rules. Versioned and audited; defaults from the project.

kind?Kind
Default"compliance_profile"
schema_version?Schema Version
Default"1"
audience_tenant_id*Audience Tenant Id
Formatuuid
version*Version

Increases by one on every change.

Range1 <= value
data_regions*array<>

Where prompts and outputs may be processed. ['any'] means unrestricted.

Items1 <= items
allowed_providers?array<>|

Narrower than the workspace list. Empty means the workspace's.

allowed_model_classes?array<>|null
provider_retention?ProviderRetention
Default"standard"
Value in"zero_retention_required""standard"
max_classification_to_external?DataClassification

Highest data class that may be sent to a model Sparq does not host itself.

Default"internal"
Value in"public""internal""confidential""restricted"
features_locked?

Features forced off (false) or on (true) for this client.

trace_content_policy?TraceContentPolicy

Highest level of prompt and response content allowed in trace destinations.

Default"off"
Value in"off""redacted""full"
retention_days?Retention Days
Range1 <= value <= 3650
Default180
approval_strictness?ApprovalStrictness
Default"standard"
Value in"standard""strict"
ai_use_restrictions?array<>

Contract clauses enforced as policy rules, in plain English.

Example Request
curl -X PUT 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/audience-tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/compliance-profile' \  -H 'Content-Type: application/json' \  -d '{  "audience_tenant_id": "0287c3f7-886a-49f4-a73e-03577e798c26",  "version": 1,  "data_regions": [    "eu"  ]}'
Example Response
{  "kind": "compliance_profile",  "schema_version": "1",  "audience_tenant_id": "0287c3f7-886a-49f4-a73e-03577e798c26",  "version": 1,  "data_regions": [    "eu"  ],  "allowed_providers": [    "string"  ],  "allowed_model_classes": [    "fast"  ],  "provider_retention": "zero_retention_required",  "max_classification_to_external": "public",  "features_locked": {},  "trace_content_policy": "off",  "retention_days": 180,  "approval_strictness": "standard",  "ai_use_restrictions": [    "string"  ]}

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

Create Credential POST

Create a credential. A generated secret is returned once, in this response only. A project credential lives in its project's workspace; one without a project lives in the caller's own workspace.