Skip to navigation
aVenture APIAgents and SystemResearch Runs

Get a Research Draft Section Write

View as Markdown

Collects a writer-brief section edit the PUT filed as a background write; its 202 Location names it. Answers 202 while the writer runs, 200 with the draft at the version the write produced, 409 when the draft changed first, 422 when the writer refused the brief, and 503 when the write ended without a draft (re-send the edit). Only the caller that filed it may read it.

Authentication

AuthorizationBearer

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

Path parameters

runIdstringRequiredformat: "uuid"
Research run id
sectionKeystringRequired
Section key the write targets
writeIdstringRequiredformat: "uuid"
Section write id from the PUT's Location

Response headers

X-RateLimit-LimitintegerOptional

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

X-RateLimit-RemainingintegerOptional

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

X-RateLimit-ResetintegerOptional

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

Response

Draft written
entityIdstringformat: "uuid"
Entity researched by this run.
runIdstringformat: "uuid"
Run that owns this private draft.
sectionlist of objects
Current sections, each identified by its snippet type key.
versioninteger>=0

Latest analysis-section event sequence; zero before the first section.

verificationobject or nullOptional
Acceptance and publication outcomes recorded for this draft version.

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