runs

Update a Run

Changed on

Updates a run identified by its ID. The body should contain only the fields to be changed; unknown fields are ignored.

patch/api/v1/runs/{run_id}

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/runs/{run_id}
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Path parameters

run_idstring uuid required

Run ID

Request body

addressstring

Addresses the run to an Agent environment in place of session_id or session_name, as lrn:agents/{id}/environments/{environment}. The environment is case-insensitive. Self-hosted deployments need LangSmith v0.18 or later.

dotted_orderstring
end_timestring
errorstring
eventsobject[]
extraobject
idstring
input_attachmentsobject
inputsobject
namestring
output_attachmentsobject
outputsobject
parent_run_idstring
reference_example_idstring
run_type'tool' | 'chain' | 'llm' | 'retriever' | 'embedding' | 'prompt' | 'parser'
serializedobject
session_idstring
session_namestring
start_timestring
statusstring
tagsstring[]
trace_idstring

Example request

{
  "address": "lrn:agents/support-agent/environments/production"
}

Changes

  • 1a8ee9358d81Revision changes
    • breaking

      added required request body

    • breaking

      removed the success response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id update_run_api_v1_runs__run_id__patch removed and replaced with

    • info

      api tag runs added

    • info

      api tag run removed

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the success response with the status