Sign in

v6

latestSwagger 2.02026-07-1340109191.2 KB

Gets a single run step from a thread run.

get/threads/{threadId}/runs/{runId}/steps/{stepId}

Path parameters

threadIdstring required

The ID of the thread that was run.

runIdstring required

The ID of the specific run to retrieve the step from.

stepIdstring required

The ID of the step to retrieve information about.

Query parameters

include[]string[]

A list of additional fields to include in the response.

Response

Information about the requested run step.

idstring required

The identifier, which can be referenced in API endpoints.

object'thread.run.step' required

The object type, which is always 'thread.run.step'.

type'message_creation' | 'tool_calls' required

The possible types of run steps.

assistant_idstring required

The ID of the assistant associated with the run step.

thread_idstring required

The ID of the thread that was run.

run_idstring required

The ID of the run that this run step is a part of.

status'in_progress' | 'cancelled' | 'failed' | 'completed' | 'expired' required

Possible values for the status of a run step.

created_atinteger required

The Unix timestamp, in seconds, representing when this object was created.

expired_atinteger nullable required

The Unix timestamp, in seconds, representing when this item expired.

completed_atinteger nullable required

The Unix timestamp, in seconds, representing when this completed.

cancelled_atinteger nullable required

The Unix timestamp, in seconds, representing when this was cancelled.

failed_atinteger nullable required

The Unix timestamp, in seconds, representing when this failed.

metadataobject nullable required

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.