Edit a Research Draft Section

PUT

https://api.aventure.vc/v1/research-runs/:runId/draft/sections/:sectionKey

PUT

/v1/research-runs/:runId/draft/sections/:sectionKey

curl -X PUT "https://api.aventure.vc/v1/research-runs/runId/draft/sections/sectionKey?expectedVersion=1" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "citation": [
    {
      "quote": "string",
      "sourceDocumentId": "string"
    }
  ],
  "key": "string",
  "origin": "string",
  "paragraph": [
    {
      "text": "string"
    }
  ],
  "title": "string"
}'

{
  "entityId": "string",
  "runId": "string",
  "section": [
    {
      "citation": [
        {
          "quote": "string",
          "sourceDocumentId": "string"
        }
      ],
      "key": "string",
      "origin": "string",
      "paragraph": [
        {
          "text": "string",
          "label": "string"
        }
      ],
      "title": "string",
      "figure": [
        {
          "entry": [
            {
              "cell": [
                {
                  "citation": 1,
                  "excerpt": "string"
                }
              ],
              "label": "string"
            }
          ],
          "title": "string",
          "type": "string",
          "column": [
            "string"
          ]
        }
      ]
    }
  ],
  "version": 1
}

Replace one section of your run's private draft. The section key must equal the path key and an exact research snippet typeValue. A stale expectedVersion returns 409 without changing the draft. Read your draft's latest version before retrying. Editing an existing run uses no additional research allowance.

Authentication

AuthorizationBearer

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

Path parameters

runIdstringRequiredformat: "uuid"

Research run id

sectionKeystringRequired

Exact research snippet typeValue, matching the section body key.

Query parameters

expectedVersionintegerRequired

Version returned by the draft read; zero before the first edit.

Request

This endpoint expects an object.

citationlist of objectsRequired

Stored source documents and verbatim evidence quotes; verification occurs before publication.

keystringRequired

Exact typeValue from GET /v1/entities/research-snippets/types; also the section path key.

originstringRequired

Author of this edit; the server derives this from the authenticated caller.

paragraphlist of objectsRequired

Paragraphs in catalog order, satisfying paragraphShape and analysisSectionLabel.

titlestringRequired

Heading displayed above this section.

figurelist of objectsOptional

At most two figures illustrating this section; each cell excerpts one of its quotes.

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

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.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found 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