SparQDocs
GuidesAPI referencesparqhq.ai
API referenceKnowledge

Reindex Document

POST
/v1/admin/documents/{document_id}/reindex

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

document_id*Document 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

Response Body

Successful Response

application/json
  1. response
document_id*Document Id
Formatuuid
collection_id*Collection Id
Formatuuid
audience_tenant_id*|

The client the document belongs to; empty for the general part.

title*Title
media_type*Media Type
size_bytes*Size Bytes
Range0 <= value
classification*DataClassification

How sensitive data is. Ordered: each level is more sensitive than the one before.

Value in"public""internal""confidential""restricted"
version*Version
Range1 <= value
content_hash*string|null
status*DocumentStatus
Value in"uploaded""scanning""indexing""ready""failed"
error*|

Why indexing failed, without document content.

created_at*Created At
Formatdate-time
updated_at*Updated At
Formatdate-time
Example Request
curl -X POST 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/reindex'
Example Response
{  "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",  "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",  "audience_tenant_id": "0287c3f7-886a-49f4-a73e-03577e798c26",  "title": "string",  "media_type": "string",  "size_bytes": 0,  "classification": "public",  "version": 1,  "content_hash": "string",  "status": "uploaded",  "error": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

List Documents GET

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

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.