Search index

Execute a search query against the specified index. Note: annotation index requires admin privileges.

post/api/v3/search/{indexName}

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
API key in cookie JSESSIONID
TypeScript
https://skmtc.dev/wildmeorg/apis/wildbook-v3-api/docs/api/v3/search/:indexName/post.ts
A function with typed inputs. Its response is checked against the schema.

Name of the index to search

frominteger

Pagination offset

sizeinteger

Number of results to return

sortstring

Sort field

sortOrder'asc' | 'desc'

Sort order

SearchQuery required

OpenSearch/Elasticsearch query body

Search results

successboolean

searchQueryIdstring uuid

hitsobject[]

querySearchQuery

OpenSearch/Elasticsearch query body

No recorded changes to this operation across all 7 revisions of this API.