Read run - Docs by LangChain

Error

A valid request URL is required to generate request examples

{
  "name": "<string>",
  "trace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dotted_order": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "app_path": "<string>",
  "inputs": {},
  "inputs_preview": "<string>",
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "extra": {},
  "error": "<string>",
  "execution_order": 1,
  "serialized": {},
  "outputs": {},
  "outputs_preview": "<string>",
  "parent_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "manifest_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "manifest_s3_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "events": [
    {}
  ],
  "tags": [
    "<string>"
  ],
  "inputs_s3_urls": {},
  "outputs_s3_urls": {},
  "s3_urls": {},
  "trace_min_start_time": "2023-11-07T05:31:56Z",
  "trace_max_start_time": "2023-11-07T05:31:56Z",
  "child_run_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "direct_child_run_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "parent_run_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "feedback_stats": {},
  "reference_example_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total_tokens": 0,
  "prompt_tokens": 0,
  "completion_tokens": 0,
  "prompt_token_details": {},
  "completion_token_details": {},
  "total_cost": "<string>",
  "prompt_cost": "<string>",
  "completion_cost": "<string>",
  "prompt_cost_details": {},
  "completion_cost_details": {},
  "price_model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "first_token_time": "2023-11-07T05:31:56Z",
  "messages": [
    {}
  ],
  "last_queued_at": "2023-11-07T05:31:56Z",
  "in_dataset": true,
  "share_token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "trace_first_received_at": "2023-11-07T05:31:56Z",
  "ttl_seconds": 123,
  "trace_upgrade": false,
  "reference_dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "thread_id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

api

runs

{run_id}

Error

A valid request URL is required to generate request examples

{
  "name": "<string>",
  "trace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dotted_order": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "app_path": "<string>",
  "inputs": {},
  "inputs_preview": "<string>",
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "extra": {},
  "error": "<string>",
  "execution_order": 1,
  "serialized": {},
  "outputs": {},
  "outputs_preview": "<string>",
  "parent_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "manifest_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "manifest_s3_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "events": [
    {}
  ],
  "tags": [
    "<string>"
  ],
  "inputs_s3_urls": {},
  "outputs_s3_urls": {},
  "s3_urls": {},
  "trace_min_start_time": "2023-11-07T05:31:56Z",
  "trace_max_start_time": "2023-11-07T05:31:56Z",
  "child_run_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "direct_child_run_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "parent_run_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "feedback_stats": {},
  "reference_example_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total_tokens": 0,
  "prompt_tokens": 0,
  "completion_tokens": 0,
  "prompt_token_details": {},
  "completion_token_details": {},
  "total_cost": "<string>",
  "prompt_cost": "<string>",
  "completion_cost": "<string>",
  "prompt_cost_details": {},
  "completion_cost_details": {},
  "price_model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "first_token_time": "2023-11-07T05:31:56Z",
  "messages": [
    {}
  ],
  "last_queued_at": "2023-11-07T05:31:56Z",
  "in_dataset": true,
  "share_token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "trace_first_received_at": "2023-11-07T05:31:56Z",
  "ttl_seconds": 123,
  "trace_upgrade": false,
  "reference_dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "thread_id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Path Parameters

run_id

string<uuid>

required

Query Parameters

session_id

string<uuid> | null

start_time

string<date-time> | null

exclude_s3_stored_attributes

boolean

default:false

exclude_serialized

boolean

default:false

include_messages

boolean

default:false

Response

Successful Response

Run schema.

name

string

required

run_type

enum<string>

required

Enum for run types.

Available options:

tool,

chain,

llm,

retriever,

embedding,

prompt,

parser

trace_id

string<uuid>

required

dotted_order

string

required

string<uuid>

required

status

string

required

session_id

string<uuid>

required

app_path

string

required

inputs

Inputs · object | null

inputs_preview

string | null

start_time

string<date-time>

end_time

string<date-time> | null

extra

Extra · object | null

error

string | null

execution_order

integer

default:1

Required range: x >= 1

serialized

Serialized · object | null

outputs

Outputs · object | null

outputs_preview

string | null

parent_run_id

string<uuid> | null

manifest_id

string<uuid> | null

manifest_s3_id

string<uuid> | null

events

Events · object[] | null