Skip to main content
GET
/
v1
/
collections
/
{collection_identifier}
/
documents
/
{document_id}
Get a document by ID.
curl --request GET \
  --url https://api.mixpeek.com/v1/collections/{collection_identifier}/documents/{document_id}
{}

Headers

​
Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

​
X-Namespace
string

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
collection_identifier
string
required

The ID of the collection.

​
document_id
string
required

The ID of the document to retrieve.

Query Parameters

​
return_url
boolean | null
default:false
​
return_vectors
boolean | null
default:false

Response

Successful Response

The response is of type object.