SparQDocs
GuidesAPI referencesparqhq.ai
API referenceKnowledge

Search Collection

POST
/v1/admin/collections/{collection_id}/search

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.

For admins and the playground. Agents search through a runtime tool instead.

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

collection_id*Collection 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

Body of POST /v1/admin/collections/{collection_id}/search (admins and the playground). Agents search through a runtime tool instead.

query*Query
Length1 <= length <= 2000
top_k?Top K
Range1 <= value <= 50
Default8
min_score?Min Score
Range0 <= value <= 1
Default0.3
audience_tenant_id?|

Also search this client's part (needs access to that client).

Response Body

Successful Response

application/json
  1. response
passages*array<>
Example Request
curl -X POST 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/collections/497f6eca-6276-4993-bfeb-53cbbbba6f08/search' \  -H 'Content-Type: application/json' \  -d '{  "query": "string"}'
Example Response
{  "passages": [    {      "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",      "ordinal": 0,      "text": "string",      "score": 0,      "source": {        "source_id": "string",        "title": "string",        "uri": "string",        "excerpt": "string"      }    }  ]}

Request Upload 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. A short-lived URL to upload one file; scanning and indexing start when it arrives.

Apply Registry Change 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.