N-Shot

Override an N-Shot value

Override an N-Shot cell for a document-field pair by selecting a specific shot's value.

post/v1/jobs/runs/{runId}/nshot/override

Request

  • Base URL: https://api.talonic.com
  • URL: https://api.talonic.com/v1/jobs/runs/{runId}/nshot/override
  • Auth: HTTP bearer

Path parameters

runIdstring uuid required
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Job run ID.

Request body

document_idstring uuid required
field_namestring required
selected_shotinteger required

Shot number (index) whose value should become the cell value.

reasonstring

Optional human-readable reason for the override, stored in the audit trail.

Example request

{
  "document_id": "f0e1d2c3-b4a5-9687-8765-432109876543",
  "field_name": "invoice_number",
  "selected_shot": 2
}

Response

The full updated comparison object, including the applied override.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.