SparQDocs
GuidesAPI referencesparqhq.ai
API referenceKnowledge

List Documents

GET
/v1/admin/collections/{collection_id}/documents

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

collection_id*Collection Id
Formatuuid

Query Parameters

limit?Limit

Items per page (default 50, at most 200).

Range1 <= value <= 200
Default50
cursor?|

Opaque next_cursor from the previous page.

sort?|

Field to sort by; '-' for descending. Ties break on the id.

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

Response Body

Successful Response

application/json
  1. response
next_cursor*|

Pass as cursor for the next page; empty at the end.

total?|

Number of matching items, only when cheap to count.

items*array<>
Example Request
curl -X GET 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/collections/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents'
Example Response
{  "next_cursor": "string",  "total": 0,  "items": [    {      "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 Collections 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.

Reindex Document 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.