Runs

List Run Steps

Get messages associated with a run with filtering options.

Args: run_id: ID of the run before: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. after: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. limit: Maximum number of steps to return order: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

Returns: A list of steps associated with the run.

Path parameters

run_idstringRequired

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Query parameters

beforestringOptional

Cursor for pagination

afterstringOptional

Cursor for pagination

limitintegerOptional

Maximum number of messages to return

orderstringOptionalDefaults to desc

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

Response

Successful Response

idstring

The id of the step. Assigned by the database.

originstringOptional

The surface that this agent step was initiated from.

provider_idstringOptional

The unique identifier of the provider that was configured for this step

job_idstringOptional

The unique identifier of the job that this step belongs to. Only included for async calls.

agent_idstringOptional

The ID of the agent that performed the step.

provider_namestringOptional

The name of the provider used for this step.

modelstringOptional

The name of the model used for this step.

model_endpointstringOptional

The model endpoint url used for this step.

context_window_limitintegerOptional

The context window limit configured for this step.

completion_tokensintegerOptional

The number of tokens generated by the agent during this step.

prompt_tokensintegerOptional

The number of tokens in the prompt during this step.

total_tokensintegerOptional

The total number of tokens processed by the agent during this step.

completion_tokens_detailsmap from strings to anyOptional

Metadata for the agent.

tagslist of stringsOptional

Metadata tags.

tidstringOptional

The unique identifier of the transaction that processed this step.

trace_idstringOptional

The trace id of the agent step.

messageslist of objectsOptional

The messages generated during this step.

Errors