Put Client Pack
Not available yet. This operation is part of the published contract and answers
501 not_implementeduntil it is built. The request and response shapes below are final for this contract version.
HTTPBearerAuthorizationBearer <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.
audience_tenant_id*Audience Tenant IduuidSparq-Workspace?stringFor 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.
uuidIf-Match?stringThe ETag you last read. A different current version is precondition_failed (412). Optional in 0.5.0.
application/json- body
kind?Kind"client_pack"schema_version?Schema Version"1"audience_tenant_id*Audience Tenant Iduuidversion*Version1 <= valuevocabulary?array<>items <= 500instructions?InstructionsExtra instructions for this client. Linted like any instruction text.
length <= 4000""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.
Successful Response
application/json- response
kind?Kind"client_pack"schema_version?Schema Version"1"audience_tenant_id*Audience Tenant Iduuidversion*Version1 <= valuevocabulary?array<>items <= 500instructions?InstructionsExtra instructions for this client. Linted like any instruction text.
length <= 4000""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.
curl -X PUT 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/audience-tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/client-pack' \ -H 'Content-Type: application/json' \ -d '{ "audience_tenant_id": "0287c3f7-886a-49f4-a73e-03577e798c26", "version": 1}'{ "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}