Skip to main content
POST
Error

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
address
object

Beta. Addresses the run to an Agent environment in place of session_id or session_name. Cannot be combined with agent_id or agent_environment. Only workspaces enabled for Agent addressing accept it; others get a 403.

​
agent_environment
enum<string>

Beta. The Agent environment the run belongs to, case-insensitive; requires agent_id. Only workspaces enabled for Agent addressing accept it; others get a 403.

Available options:
LOCAL,
DEVELOPMENT,
STAGING,
PRODUCTION
​
agent_id
string

Beta, superseded by address. Addresses the run to an Agent, with agent_environment, in place of session_id or session_name. Only workspaces enabled for Agent addressing accept it; others get a 403.

​
dotted_order
string
​
end_time
string
​
error
string
​
events
object[]
​
extra
object
​
id
string
​
input_attachments
object
​
inputs
object
​
name
string
​
output_attachments
object
​
outputs
object
​
parent_run_id
string
​
reference_example_id
string
​
run_type
enum<string>
Available options:
tool,
chain,
llm,
retriever,
embedding,
prompt,
parser
​
serialized
object
​
session_id
string
​
session_name
string
​
start_time
string
​
status
string
​
tags
string[]
​
trace_id
string

Response

Run created

​
{key}
any