BYO Documents

Get a document by ID (path-scoped namespace)

Changed on

Fetch a single document by document_id from a namespace named in the PATH — the mirror of POST /v1/namespaces/{namespace_id}/documents/upsert, so directly-upserted (BYO/standalone) documents can be read back on the same URL convention they were written with. Equivalent to GET /v1/documents/{document_id} with the X-Namespace header.

get/v1/namespaces/{namespace_id}/documents/{document_id}

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/namespaces/{namespace_id}/documents/{document_id}
  • Auth: HTTP bearer

Path parameters

namespace_idstring required

Namespace name or ID the document lives in.

Example:ns_abc123def456
document_idstring required

The document_id to fetch.

Example:doc_001

Query parameters

return_vectorsboolean

Response

Successful Response

unknown required

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API