检索运行步骤

Retrieves a run step.

get

https://api.portkey.ai/v1SELF_HOSTED_GATEWAY_URL

/threads/{thread_id}/runs/{run_id}/steps/{step_id}

Authorizations

Portkey-Key & Virtual-KeyPortkey-Key & Provider-Auth & Provider-NameConfig & Portkey-KeyCustom-Host & Portkey-Key & Provider-Auth & Provider-Name

x-portkey-api-keystringRequired

x-portkey-virtual-keystringRequired

Path parameters

thread_idstringRequired

The ID of the thread to which the run and run step belongs.

run_idstringRequired

The ID of the run to which the run step belongs.

step_idstringRequired

The ID of the run step to retrieve.

Responses

200

OK

application/json

Represents a step in execution of a run.

idstringRequired

The identifier of the run step, which can be referenced in API endpoints.

objectstring · enumRequired

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

Possible values:

created_atintegerRequired

The Unix timestamp (in seconds) for when the run step was created.

assistant_idstringRequired

The ID of the assistant associated with the run step.

thread_idstringRequired

The ID of the thread that was run.

run_idstringRequired

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

typestring · enumRequired

The type of run step, which can be either message_creation or tool_calls.

Possible values:

statusstring · enumRequired

The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.

Possible values:

step_detailsone ofRequired

The details of the run step.

or

expired_atinteger · nullableRequired

The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.

cancelled_atinteger · nullableRequired

The Unix timestamp (in seconds) for when the run step was cancelled.

failed_atinteger · nullableRequired

The Unix timestamp (in seconds) for when the run step failed.

completed_atinteger · nullableRequired

The Unix timestamp (in seconds) for when the run step completed.

metadataobject · nullableRequired

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

get

/threads/{thread_id}/runs/{run_id}/steps/{step_id}

curlpythonjavascript

curl https://api.portkey.ai/v1/threads/thread_abc123/runs/run_abc123/steps/step_abc123 \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \
  -H "Content-Type: application/json" \
  -H "OpenAI-Beta: assistants=v2"

200

OK

{
  "id": "text",
  "object": "thread.run.step",
  "created_at": 1,
  "assistant_id": "text",
  "thread_id": "text",
  "run_id": "text",
  "type": "message_creation",
  "status": "in_progress",
  "step_details": {
    "type": "message_creation",
    "message_creation": {
      "message_id": "text"
    }
  },
  "last_error": {
    "code": "server_error",
    "message": "text"
  },
  "expired_at": 1,
  "cancelled_at": 1,
  "failed_at": 1,
  "completed_at": 1,
  "metadata": {},
  "usage": {
    "completion_tokens": 1,
    "prompt_tokens": 1,
    "total_tokens": 1
  }
}