Skip to navigation
aVenture APICompaniesEntities

Get an Async Semantic Entity Search

View as Markdown

Returns the page accepted by Prefer: respond-async on POST /v1/entities/search. Answers 202 with Location and Retry-After while the search is queued or running, 200 with the canonical entity page once complete, and 404 for an unknown job.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Path parameters

jobIdstringRequiredformat: "uuid"
Entity semantic search job UUID

Response headers

X-Next-CursorstringOptional

Opaque continuation token, present when another page exists; send it as cursor to read that page. The body’s number, first, and totalPages describe offset paging only; they do not advance while you follow cursors.

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

Search completed; the canonical entity page is returned.

contentlist of objectsOptional
emptybooleanOptional
firstbooleanOptional
lastbooleanOptional
numberintegerOptional
numberOfElementsintegerOptional
pageableobjectOptional
sizeintegerOptional
sortobjectOptional
totalElementslongOptional
totalPagesintegerOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error