Skip to main content
GET
/
api
/
v1
/
annotation-queues
/
{queue_id}
/
run
/
{index}
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>",
  "queue_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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>",
  "last_reviewed_time": "2023-11-07T05:31:56Z",
  "added_at": "2023-11-07T05:31:56Z",
  "effective_added_at": "2023-11-07T05:31:56Z",
  "reserved_by": [],
  "completed_by": [],
  "source_proposed_example_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.langchain.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
queue_id
string<uuid>
required
​
index
integer
required

Query Parameters

​
include_extra
boolean
default:false

Response

Successful Response

Run schema with annotation queue info.

​
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
​
id
string<uuid>
required
​
status
string
required
​
session_id
string<uuid>
required
​
app_path
string
required
​
queue_run_id
string<uuid>
required
​
inputs
Inputs · object
​
inputs_preview
string | null
​
start_time
string<date-time>
​
end_time
string<date-time> | null
​
extra
Extra · object
​
error
string | null
​
execution_order
integer
default:1
Required range: x >= 1
​
serialized
Serialized · object
​
outputs
Outputs · object
​
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
​
tags
string[] | null
​
inputs_s3_urls
Inputs S3 Urls · object
​
outputs_s3_urls
Outputs S3 Urls · object
​
s3_urls
S3 Urls · object
​
trace_min_start_time
string<date-time> | null
​
trace_max_start_time
string<date-time> | null
​
child_run_ids
string<uuid>[] | null
​
direct_child_run_ids
string<uuid>[] | null
​
parent_run_ids
string<uuid>[] | null
​
feedback_stats
Feedback Stats · object
​
reference_example_id
string<uuid> | null
​
total_tokens
integer
default:0
​
prompt_tokens
integer
default:0
​
completion_tokens
integer
default:0
​
prompt_token_details
Prompt Token Details · object
​
completion_token_details
Completion Token Details · object
​
total_cost
string | null
​
prompt_cost
string | null
​
completion_cost
string | null
​
prompt_cost_details
Prompt Cost Details · object
​
completion_cost_details
Completion Cost Details · object
​
price_model_id
string<uuid> | null
​
first_token_time
string<date-time> | null
​
messages
Messages · object[] | null
​
last_queued_at
string<date-time> | null
​
in_dataset
boolean | null
​
share_token
string<uuid> | null
​
trace_tier
enum<string> | null
Available options:
longlived,
shortlived
​
trace_first_received_at
string<date-time> | null
​
ttl_seconds
integer | null
​
trace_upgrade
boolean
default:false
​
reference_dataset_id
string<uuid> | null
​
thread_id
string | null
​
last_reviewed_time
string<date-time> | null
​
added_at
string<date-time> | null
​
effective_added_at
string<date-time> | null
​
reserved_by
string<uuid>[]
​
completed_by
string<uuid>[]
​
source_proposed_example_id
string<uuid> | null