Skip to main content
POST
/
threads
/
{thread_id}
/
runs
/
{run_id}
cURL
curl https://api.portkey.ai/v1/threads/thread_abc123/runs/run_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" \
  -d '{
    "metadata": {
      "user_id": "user_abc123"
    }
  }'
{
  "id": "<string>",
  "object": "thread.run",
  "created_at": 123,
  "thread_id": "<string>",
  "assistant_id": "<string>",
  "status": "queued",
  "required_action": {
    "type": "submit_tool_outputs",
    "submit_tool_outputs": {
      "tool_calls": [
        {
          "id": "<string>",
          "type": "function",
          "function": {
            "name": "<string>",
            "arguments": "<string>"
          }
        }
      ]
    }
  },
  "last_error": {
    "code": "server_error",
    "message": "<string>"
  },
  "expires_at": 123,
  "started_at": 123,
  "cancelled_at": 123,
  "failed_at": 123,
  "completed_at": 123,
  "incomplete_details": {
    "reason": "max_completion_tokens"
  },
  "model": "<string>",
  "instructions": "<string>",
  "tools": [],
  "metadata": {},
  "usage": {
    "completion_tokens": 123,
    "prompt_tokens": 123,
    "total_tokens": 123
  },
  "temperature": 123,
  "top_p": 123,
  "max_prompt_tokens": 257,
  "max_completion_tokens": 257,
  "truncation_strategy": {
    "type": "auto",
    "last_messages": 2
  },
  "tool_choice": "none",
  "parallel_tool_calls": true,
  "response_format": "none"
}

Authorizations

x-portkey-api-key
string
header
required
x-portkey-virtual-key
string
header
required

Path Parameters

thread_id
string
required
run_id
string
required

Body

application/json
metadata
object | null

Response

200 - application/json
id
string
required
object
enum<string>
required
Available options:
thread.run
created_at
integer
required
thread_id
string
required
assistant_id
string
required
status
enum<string>
required
Available options:
queued,
in_progress,
requires_action,
cancelling,
cancelled,
failed,
completed,
incomplete,
expired
required_action
object | null
required
last_error
object | null
required
expires_at
integer | null
required
started_at
integer | null
required
cancelled_at
integer | null
required
failed_at
integer | null
required
completed_at
integer | null
required
incomplete_details
object | null
required
model
string
required
instructions
string
required
tools
(Code interpreter tool · object | FileSearch tool · object | Function tool · object)[]
required
Maximum length: 20
  • Code interpreter tool
  • FileSearch tool
  • Function tool
metadata
object | null
required
usage
object | null
required
max_prompt_tokens
integer | null
required
Required range: x >= 256
max_completion_tokens
integer | null
required
Required range: x >= 256
truncation_strategy
object
required
tool_choice
required
Available options:
none,
auto,
required
parallel_tool_calls
boolean
default:true
required
response_format
required
Available options:
none,
auto
temperature
number | null
top_p
number | null