Skip to navigation

Deprecated: Research a Company or Person by URL

Deprecated
View as Markdown

Deprecated: use research runs create (POST /v1/research/runs).

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
urlstringRequired

Official website or profile URL of the company, Product, Service, or person to research; a URL no current record owns researches a new one

findinglist of objects or nullOptional

Facts you already read verbatim on an external source page for an entity, each citing the page and exact text that support it. Omit taskPresetKey to default to apply-cited-findings, or send a preset from GET /v1/research/runs/presets; the run checks each quote against its page and writes only the facts it confirms. When the detail comes from an indexed news article or a page not read verbatim, send userPrompt instead.

modeenumOptional

How broadly the run researches the subject; omit it for COMPREHENSIVE

Allowed values:
modelstring or nullOptional

Model id the run uses; omit it to use the default model

namestring or nullOptional0-200 characters

Name of the subject at url, such as Clarity Health; the run verifies it and uses it to pick the right subject when the site names several

taskPresetKeylist of strings or nullOptional

Research presets that focus the run, listed by GET /v1/research/runs/presets; omit them for a full run

userPromptstring or nullOptional

Optional steering prompt, such as an observed update and its source URL (newsUrlOriginal or web URL) or which facts to check first

Response headers

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

OK
attemptinteger
Retry attempt counter
chassisenum
Agent loop this run executes on
Allowed values:
chassisRoutedboolean

True when the chassis router, not a caller, picked chassis

createdAtdatetime
Creation timestamp
environmentenum
API environment
Allowed values:
hasSourceDocumentboolean
Whether this run consumes an immutable private source document
idstringformat: "uuid"
Run id
iterationinteger
Current loop iteration
laneenum
Queue lane for admission priority
Allowed values:
llmApienum
Gateway wire API every LLM call of this run uses
Allowed values:
maxIterationinteger
Loop iteration cap
maxScoutConcurrentinteger

Parallel read-only scout fan-out width N

modeenum
Enrichment breadth selected for this run
Allowed values:
modelstring
Model the run uses
statusenum
Current lifecycle state
Allowed values:
subagentModelstring

Read-only research, cohort, and completion sub-agent model id

typeenum

Run kind: ENRICHMENT for a research request a caller filed, TASK for a narrower run aVenture scheduled

Allowed values:
updatedAtdatetime
Last update timestamp
urlstring
URL of the company, Product, Service, or person under research
entitySlugstring or nullOptional
Slug of the profile the run produced
errorstring or nullOptional

Why the run failed; null unless failed

failureClassstring or nullOptional

Typed terminal-failure class from the harness retry classifier (e.g. runtime_cap, escalated, provider_capacity, context_overflow); null unless failed

finishedAtdatetime or nullOptional
Run completion timestamp
followUpAdmissionenumOptional

Follow-up admission for the exact current terminal generation; old engine terminals remain PENDING

Allowed values:
latestStatusstring or nullOptional

Latest enrich-loop status as an opaque JSON string

nextAttemptAtdatetime or nullOptional

Earliest re-claim time when waiting on retry backoff

researchAllowanceTypestring or nullOptional

Research allowance this run reserved when it was filed: COMPANY or PERSON; null for a run filed without one

resumeSafeUntildatetime or nullOptional

Instant past which a warm resume is no longer guaranteed; the harness writes it with session_resume from the model’s cache window. Warm-resumable now iff failed/stopped and this is in the future. Null when there is no resume window.

startedAtdatetime or nullOptional
Run start timestamp
taskPresetKeylist of strings or nullOptional
Research presets filed with the run
userPromptstring or nullOptional
Optional instructions filed with the run

Errors

400
Bad Request Error
401
Unauthorized 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