POST
/v2/snapshots/{snapshot_id}/extendBetaExtend a snapshot
Adds one records or risk module to an existing snapshot and returns the updated snapshot body. This call is synchronous — it does not create a new job. Credits are charged for that module only.
Beta. This endpoint is available for production integrations, but fields, categories, and credit weights may change without a version pin.
Base URL
https://api.relativity6.comAuthentication
Send your API key in the x-api-key header. Send your organization API key.
Request body
| Field | Type | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| modules | object[] | Required | Exactly one module to add. Sending more than one module returns 400. | ||||||||
| |||||||||||
| refresh_summary | boolean | Optional | When true, regenerates the executive summary after the module is added. | ||||||||
| idempotency_key | string | Optional | Optional key so retries reuse the same amendment instead of charging again. | ||||||||
Response
| Field | Type | Required | Description |
|---|---|---|---|
| snapshot_id | string | Required | The snapshot that was extended. |
| amendment_id | string | Required | Id for this extend operation. |
| module_id | string | Required | The module that ran. |
| status | string | Required | executed when the module completed; degraded when it could not fully resolve.executed · degraded |
| refresh_summary | boolean | Required | Whether the summary was refreshed. |
| source_count_before | number | Required | Bibliography size before the extend. |
| source_count_after | number | Required | Bibliography size after the extend. |
| response_body | object | Required | Updated snapshot body, including the new module. |
Errors
| Status | Description |
|---|---|
| 200 | Module added. Degraded extends refund the module credits. |
| 400 | Invalid body (for example, missing modules or more than one module). |
| 401 | Missing or invalid API key. |
| 402 | Insufficient credits for this module. |
| 403 | Organization is not authorized for Risk API v2. |
| 404 | No snapshot exists with this id. |
| 409 | That module is already present on the snapshot. |
| 500 | Server error. Failed extends refund the module credits. |