Retrieve Run Steps

Supported Providers
  • OpenAI

Retrieves a run step.

get
Authorizations
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
get
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
  }
}

Last updated

Was this helpful?