Skip to navigation
aVenture APISearch and IdentifySearch

Deprecated: Get a Lookup Job’s State

Deprecated
View as Markdown

Deprecated: use getLookupJob at GET /v1/lookup/jobs/{jobId}. Returns the job state: 202 with Retry-After while PENDING or RUNNING, 200 once terminal. Once COMPLETED, it returns each identified name: MATCHED names the stored record, NEEDS_REVIEW lists candidates, and a failed name carries failureReason. Ordinary article jobs may include shell, enrichmentRunId, or shellDetail on NO_MATCH. Bulk jobs return maxNames and limitReached; reaching the bound means more names may remain. A single-subject job, filed by Prefer: respond-async on GET or POST /v1/lookup or POST /v1/entities/lookup, or by a signed-in live lookup on those routes that rolled over to a job, carries source.subject and, once COMPLETED, identification: the answer that route returns. Only the requesting caller can read the job.

Authentication

AuthorizationBearer

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

Path parameters

jobIdstringRequiredformat: "uuid"
Lookup job id from the create response.

Response headers

ETagstringOptional

Revision of this job snapshot; send it as If-None-Match for 304

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

The job is terminal: COMPLETED, FAILED, or CANCELED.

createdAtdatetime
When the job was requested.
jobIdstringformat: "uuid"
Lookup job id.
limitReachedboolean

True when a bulk lookup returned its name bound; more names may remain. False does not prove that extraction found every name on a page.

mentionlist of objects

Each identified company and person; bulk results are available while running.

namesProcessedinteger

Names processed so far, including per-name failures.

sourceobject
The article the job reads or names supplied for a bulk lookup.
stateenum
Current job state.
updatedAtdatetime
When the job last changed state.
failureReasonstring or nullOptional

Why the job failed; absent unless state is FAILED.

identificationobject or nullOptional

Subject jobs only: once COMPLETED, the identification GET or POST /v1/lookup or POST /v1/entities/lookup returns for source.subject, including requested filing and source-claim outcomes; absent otherwise.

maxNamesinteger or nullOptional

Bulk lookup name bound; absent for legacy article jobs.

namesFoundinteger or nullOptional

Distinct names found for a bulk lookup; absent on standard jobs.

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