SparQDocs
GuidesAPI referencesparqhq.ai
API referenceKnowledge

Create Collection

POST
/v1/admin/projects/{project_id}/collections

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

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

Request Body

application/json
  1. body
name*Name

How agents name the collection in AgentSpec.knowledge.

Match^[a-z][a-z0-9_-]{0,62}$
description?|null
tier?Tier
Default"general"
Value in"general""audience_tenant""internal"

Response Body

Successful Response

application/json
  1. response
collection_id*Collection Id
Formatuuid
project_id*Project Id
Formatuuid
name*Name

Lower-case name: a letter, then letters, digits, '_' or '-'. Max 63.

Match^[a-z][a-z0-9_-]{0,62}$
description*string|null
tier*Tier
Value in"general""audience_tenant""internal"
documents*Documents
Range0 <= value
used_by_agents*array<>

Agents whose live spec names this collection.

created_at*Created At
Formatdate-time
Example Request
curl -X POST 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/collections' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
Example Response
{  "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",  "name": "string",  "description": "string",  "tier": "general",  "documents": 0,  "used_by_agents": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z"}

Whoami GET

Who Sparq thinks the caller is: principal, credential, project and tenant.

Delete Document DELETE

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