Paper outline

Title, authors, abstract, inferred summary, and the section tree with per-section token counts, plus figure/table captions and counts.

GET/{idv}/outline.json

Path parameters

idvstringrequired

arXiv ID, optionally with version (1706.03762, 1706.03762v7). Old-style IDs keep their slash (hep-th/9901001v1). Unversioned resolves to the latest version.

Query parameters

asyncboolean

Same as Prefer: respond-async. Presence is enough (?async).

waitinteger

Same as Prefer: wait=N. Capped at 60.

min 0 · max 60

Header parameters

Preferstring

RFC 7240. wait=N waits up to N seconds (max 60) for inferred fields; respond-async returns 202 + Location when the tree is not yet built.

Responses

200

schemanumberrequired

Major schema version

Allowed:1

idPaperIdrequired

arXiv identifier without version: new style 1706.03762 or old style hep-th/9901001

matches ^(?:\d{4}\.\d{4,5}|[a-z-]+(?:\.[A-Z]{2})?\/\d{7})$

versionVersionrequired

arXiv version number (1-based)

min 1 · max 9007199254740991

idvIdvrequired

arXiv identifier with version, e.g. 1706.03762v7

matches ^(?:\d{4}\.\d{4,5}|[a-z-]+(?:\.[A-Z]{2})?\/\d{7})v[1-9]\d*$

titlestringrequired

authorsstring[]required

primaryCategorystringrequired

submittedAtstringrequired

inferredobjectrequired

Show properties

statusstringrequired

Allowed:pendingfailedready

tldrstring

contributionsstring[]

paperTypestring

tokensTokensrequired

Approximate token count, ceil(chars / 4)

Show properties

approxintegerrequired

min 0 · max 9007199254740991

methodstringrequired

Allowed:chars/4

abstractstringrequired

sectionsOutlineSection[]required

Show properties

Array of OutlineSection

idstringrequired

LaTeXML id, e.g. S3.SS2

aliasstringrequired

Short alias, e.g. S3.2

numberstring

titlestringrequired

tokensintegerrequired

Approximate tokens of the section markdown

min 0 · max 9007199254740991

childrenOutlineSection[]required

Show properties

Array of OutlineSection

Circular reference to OutlineSection.

figuresOutlineFloat[]required

Show properties

Array of OutlineFloat

idstringrequired

numberstring

captionstringrequired

tablesOutlineFloat[]required

Show properties

Array of OutlineFloat

idstringrequired

numberstring

captionstringrequired

equationsintegerrequired

min 0 · max 9007199254740991

referencesintegerrequired

min 0 · max 9007199254740991

202

Accepted (Prefer: respond-async or ?async, tree not yet built). Poll Location (the requested URL).

statusstringrequired

Allowed:building

locationstringrequired

400

Invalid paper ID

typestringrequired

https://arxivv.org/errors/{code}

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstring

instancestring

codeErrorCoderequired

Machine-readable error code

Allowed:not-foundinvalid-idno-htmlupstreambuild-failedrate-limited

404

Paper, version or part not found

typestringrequired

https://arxivv.org/errors/{code}

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstring

instancestring

codeErrorCoderequired

Machine-readable error code

Allowed:not-foundinvalid-idno-htmlupstreambuild-failedrate-limited

422

arXiv has no HTML for this version

typestringrequired

https://arxivv.org/errors/{code}

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstring

instancestring

codeErrorCoderequired

Machine-readable error code

Allowed:not-foundinvalid-idno-htmlupstreambuild-failedrate-limited

429

Rate limit exceeded

typestringrequired

https://arxivv.org/errors/{code}

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstring

instancestring

codeErrorCoderequired

Machine-readable error code

Allowed:not-foundinvalid-idno-htmlupstreambuild-failedrate-limited

500

Tree build failed

typestringrequired

https://arxivv.org/errors/{code}

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstring

instancestring

codeErrorCoderequired

Machine-readable error code

Allowed:not-foundinvalid-idno-htmlupstreambuild-failedrate-limited

502

arXiv (or another upstream) returned an error

typestringrequired

https://arxivv.org/errors/{code}

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstring

instancestring

codeErrorCoderequired

Machine-readable error code

Allowed:not-foundinvalid-idno-htmlupstreambuild-failedrate-limited

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Parameters

idvpath*arXiv ID, optionally with version (`1706.03762`, `1706.03762v7`). Old-style IDs keep their slash (`hep-th/9901001v1`). Unversioned resolves to the latest version.PreferheaderRFC 7240. `wait=N` waits up to N seconds (max 60) for inferred fields; `respond-async` returns 202 + Location when the tree is not yet built.asyncquerySame as `Prefer: respond-async`. Presence is enough (`?async`).waitquerySame as `Prefer: wait=N`. Capped at 60.

Request

curl -X GET 'https://arxivv.org/1706.03762/outline.json' \
  -H 'Accept: application/json'

const response = await fetch("https://arxivv.org/1706.03762/outline.json", {
  method: "GET",
  headers: {
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://arxivv.org/1706.03762/outline.json",
    headers={
        "Accept": "application/json"
    },
)

Response

{
  "schema": 1,
  "id": "string",
  "version": 1,
  "idv": "string",
  "title": "string",
  "authors": [
    "string"
  ],
  "primaryCategory": "string",
  "submittedAt": "string",
  "inferred": {
    "status": "pending",
    "tldr": "string",
    "contributions": [
      "string"
    ],
    "paperType": "string"
  },
  "tokens": {
    "approx": 0,
    "method": "chars/4"
  },
  "abstract": "string",
  "sections": [
    {
      "id": "string",
      "alias": "string",
      "number": "string",
      "title": "string",
      "tokens": 0,
      "children": [
        {}
      ]
    }
  ],
  "figures": [
    {
      "id": "string",
      "number": "string",
      "caption": "string"
    }
  ],
  "tables": [
    {
      "id": "string",
      "number": "string",
      "caption": "string"
    }
  ],
  "equations": 0,
  "references": 0
}

{
  "status": "building",
  "location": "string"
}

{
  "type": "https://arxivv.org/errors/invalid-id",
  "title": "Invalid paper ID",
  "status": 400,
  "detail": "Invalid paper ID",
  "instance": "/1706.03762v7.md",
  "code": "invalid-id"
}

{
  "type": "https://arxivv.org/errors/not-found",
  "title": "Not found",
  "status": 404,
  "detail": "Paper, version or part not found",
  "instance": "/1706.03762v7.md",
  "code": "not-found"
}

{
  "type": "https://arxivv.org/errors/no-html",
  "title": "arXiv has no HTML for this version",
  "status": 422,
  "detail": "arXiv has no HTML for this version",
  "instance": "/1706.03762v7.md",
  "code": "no-html"
}

{
  "type": "https://arxivv.org/errors/rate-limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "detail": "Rate limit exceeded",
  "instance": "/1706.03762v7.md",
  "code": "rate-limited"
}

{
  "type": "https://arxivv.org/errors/build-failed",
  "title": "Tree build failed",
  "status": 500,
  "detail": "Tree build failed",
  "instance": "/1706.03762v7.md",
  "code": "build-failed"
}

{
  "type": "https://arxivv.org/errors/upstream",
  "title": "Upstream error",
  "status": 502,
  "detail": "arXiv (or another upstream) returned an error",
  "instance": "/1706.03762v7.md",
  "code": "upstream"
}