Query entities
Returns the current edition of each entity the caller may view that is not archived and meets filter, if given, a page at a time, in a stable order. The Link header names the next page.
Query ParametersCopy link to this section
The page to return, as the previous page's Link header names it. Defaults to the first.
The size of the page; the server's maximum is the default and caps larger values.
Request BodyCopy link to this section
The query.
ResponseCopy link to this section
A page of the entities the query matches.
The entities on this page.
HeadersCopy link to this section
Names the next page as <URI>; rel="next" (RFC 8288). The URI is relative and resolves against the URL of this request. Repeat the request there, with the same body if it has one. The last page has no Link header.
Example: <?cursor=...>; rel="next"
The budgets the request was checked against, one item each, as draft-ietf-httpapi-ratelimit-headers-11 defines them. q is the burst a budget admits at once, and w the whole seconds an exhausted budget takes to refill, so q requests per w seconds stay within its sustained rate.
Example: "actor";q=500;w=50
The requests each budget in RateLimit-Policy has left after this request, as its r. A crossed budget reports r=0.
Example: "actor";r=499
Always private, no-store: the response depends on the caller, so no cache stores it.
Example: private, no-store
curl -X POST 'https://api.hash.ai/entities/v1/query' \ -H 'Content-Type: application/json' \ -d '{}' \ -H "Authorization: Bearer $HASH_API_KEY"{ "entities": [ { "metadata": { "entityId": "8d86c8c3-d66d-43d1-859b-676c3bcaeadc~be2c5b2f-e3e1-4f26-a0c4-0f8b5e9c4a1d", "entityTypeIds": [ "https://hash.ai/@h/types/entity-type/user/v/1" ], "provenance": { "actorType": "user", "origin": { "type": "external" } } }, "properties": { "https://hash.ai/@h/types/property-type/preferred-name/": "Alice", "https://hash.ai/@h/types/property-type/shortname/": "alice" }, "propertyMetadata": { "https://hash.ai/@h/types/property-type/preferred-name/": { "dataTypeId": "https://blockprotocol.org/@blockprotocol/types/data-type/text/v/1" }, "https://hash.ai/@h/types/property-type/shortname/": { "dataTypeId": "https://blockprotocol.org/@blockprotocol/types/data-type/text/v/1" } } } ]}