Retrieve Step

GET
/v1/steps/:step_id

Get a step by ID.

Path parameters

step_idstringRequired

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

Built with