Start identifying every company and person an article names

View as Markdown
Reads one article (sourceUrl or sourceNewsId), extracts the companies and people it names, and identifies each one as POST /v1/lookup would with the article as its source. Poll the returned status URL with GET /v1/lookup-jobs/{jobId}. Spends one natural-search quota slot for each name the job may identify, up to its per-article limit, when it is accepted. For a name no stored record is, the job creates a hidden shell record at no charge only when a second live page on another site names it too; enrich that shell by its id. The same article sent again soon returns the earlier job without spending quota again. Example body: {"sourceUrl":"https://techcrunch.com/2024/01/01/example"}.

Authentication

AuthorizationBearer

User bearer token: an aVenture API key, an OAuth access token, or a signed-in session token

Query parameters

includePrivatebooleanOptional

Also considers hidden and unpublished records; needs private-visibility authority. Without it, NO_MATCH covers only records you can see.

Request

This endpoint expects an object.
sourceNewsIdinteger or nullOptional

aVenture news id of the article; an unknown id fails the job.

sourceUrlstring or nullOptional0-2000 characters

URL of the article; read from aVenture news when stored there, otherwise fetched.

Response headers

LocationstringOptional
Endpoint to poll for the job state and result.
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 lookup job was accepted; poll its status URL.

jobIdstringformat: "uuid"
modestring
statusUrlstring
Endpoint to poll for asynchronous job state and result.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error