/autocomplete endpoints are designed for type-ahead and search-as-you-type interfaces. They return lightweight suggestion objects — display name, entity type, and a contextual hint — without the full metadata payload of the primary resource endpoints. You can search across all entity types at once or scope your query to a specific entity.
Autocomplete requests count against your rate limit. Debounce requests in type-ahead interfaces to avoid exhausting your quota — a delay of 200–300 ms after the last keystroke is a common best practice.
Search all entity types
Returns suggestions matching the query across all Hexagraph entity types: outputs, authors, sources, institutions, publishers, and funders.The search query string. Matched against display names across all entity types. Minimum 1 character.
Search a specific entity type
Scope autocomplete suggestions to a single entity type for more targeted results.The entity type to search within. Must be one of:
outputs, authors, sources, institutions, publishers, funders.The search query string, matched against display names for the specified entity type.
Response fields
The
OA:-prefixed unique identifier for the matched entity. Prefix reflects the entity type (e.g. OA:W for outputs, OA:A for authors). Pass this ID to the corresponding resource endpoint to retrieve the full record.Human-readable name of the matched entity — the title for outputs, or the name for authors, sources, institutions, publishers, and funders.
The type of entity matched. One of:
output, author, source, institution, publisher, funder.A short contextual string suitable for rendering as a secondary label beneath
display_name in a suggestion list. Content varies by entity type (e.g. year and source name for outputs, citation count and affiliation for authors).Related endpoints: use the returned
id with Outputs, Authors, Sources, Institutions, Publishers, or Funders to retrieve full entity records.