Get research

Returns a research run as it stands, at once. It never waits. A finished run stays readable until expiresAt, seven days past the end, also while its bucket is offline. After that it is 404 not_found. Use sources and sourceLimit to read fewer sources at a time, and sourceCursor to read the next page. Requires the viewer role.

GET/v1/workspaces/{workspaceId}/research/{researchId}

Authentication

Send your Graphon API key with every request. The value is the whole API key that Graphon showed when you created it. See Authentication.

Authorization: Bearer <GRAPHON_API_KEY>

curl \
  --url "https://api.graphon.ai/v1/workspaces/wspq7ws2np5l8z4/research/rscR7tY2kL9mP" \
  --header "Authorization: Bearer $GRAPHON_API_KEY"

Request

Loading your session…

Response

JSON

{
  "research": {
    "id": "rscR7tY2kL9mP",
    "workspaceId": "wsp4k9m2x7q1z8r",
    "target": "bktA1b2C3d4E5",
    "status": "succeeded",
    "query": "Why did checkout stall after the 3 October deploy?",
    "history": [],
    "keys": [],
    "keyPrefix": null,
    "filter": null,
    "answer": "Release 4.18 raised checkout workers from 8 to 24 but left the database pool at 200 [[SRC:0001]].",
    "sources": [
      {
        "ref": "SRC:0001",
        "key": "incidents/2026-10-03-checkout.pdf",
        "versionId": "ver_3f9c2a7d1e4b4c8a9f0d6b2e5a1c7d3f",
        "contentType": "application/pdf",
        "score": 0.86,
        "cited": true,
        "span": {
          "key": "incidents/2026-10-03-checkout.pdf",
          "versionId": "ver_3f9c2a7d1e4b4c8a9f0d6b2e5a1c7d3f",
          "unit": "pages",
          "start": 2,
          "end": 3
        }
      }
    ],
    "sourcesNextCursor": null,
    "warnings": [],
    "error": null,
    "imageDescription": null,
    "createdBy": {
      "userId": null,
      "apiKeyId": "apkH3sK8pW2xQ"
    },
    "createdAt": "2026-10-12T09:00:00.000Z",
    "completedAt": "2026-10-12T09:03:42.210Z",
    "expiresAt": "2026-10-19T09:03:42.210Z"
  }
}

Path parameters

workspaceIdstring

The workspace id.

researchIdstring

The query run id.

Query parameters

sourcesstring (optional)

cited: only the sources that the answer cites. all: every source of the run: cited sources first, in the order the answer cites them, then the sources it only retrieved. Defaults to all. One of: all, cited.

sourceLimitstring (optional)

Sources on one page, 1 to 200. Defaults to 50. A smaller page keeps a tool result under its size limit.

sourceCursorstring (optional)

The sourcesNextCursor of the previous read, to read the next page of sources. Send the same sources and sourceLimit. Defaults to the first page.

Was this page helpful?

View as Markdown