Get a Research Run Draft

GET

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

GET

/v1/research-runs/:runId/draft

curl https://api.aventure.vc/v1/research-runs/runId/draft \
     -H "Authorization: Bearer <token>"

{
  "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
}

Read the latest private draft of a research run you own. Version is zero before the first section edit; use the returned version when editing a section.

Authentication

AuthorizationBearer

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

Path parameters

runIdstringRequiredformat: "uuid"

Research run id

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

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error