Galon Cloud
Galon API v1

/search/indexes/{name}

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

GET /search/indexes/{name}

Read a search index

Read an index: schema and document count. Use when checking which fields can be searched, filtered, sorted or faceted. Before: an index name from search_list_indexes. Returns the index and its fields. Scope: search:query.

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

Parameters

NameInTypeDescription
namepathstring · requiredIndex name.

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>" \
  -H "Authorization: Bearer $GALON_API_KEY"

DELETE /search/indexes/{name}

Delete a search index

Delete an index and all its documents. Use when the user asks to remove an index for good. Before: confirm with the user: this cannot be undone. Returns deleted true. Scope: search:write.

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

Parameters

NameInTypeDescription
namepathstring · requiredIndex name.

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 DELETE "$GALON_API_BASE/search/indexes/<name>" \
  -H "Authorization: Bearer $GALON_API_KEY"