Galon Cloud
Galon API v1

/search/indexes/{name}/documents/{document_id}

Base URL https://api.galon.ai/v1 · export GALON_API_BASE="https://api.galon.ai/v1"

GET /search/indexes/{name}/documents/{document_id}

Read a document

Read one document of an index by its id. Use when checking what an index holds for one record. Before: a document id from search_query. Returns the stored document. Scope: search:query.

API key (Bearer), on the public API endpoint.

Parameters

NameInTypeDescription
namepathstring · requiredIndex name.
document_idpathstring · requiredDocument id.

Responses

StatusDescriptionBody
2XXSuccess: the JSON body the route returns (see the description for its fields).object
401Key missing or invalidError
4XXRefused: act on detail.code, then follow detail.next_action (404 not_found while the service is not open to the account).Error

Examples

curl

curl -X GET "$GALON_API_BASE/search/indexes/<name>/documents/<document_id>" \
  -H "Authorization: Bearer $GALON_API_KEY"