Modify Run

Supported Providers

• OpenAI

Modifies a run.

post

Authorizations

Portkey-KeyVirtual-KeyProvider-AuthProvider-NameConfigCustom-Host

Path parameters

thread_idstringRequired

The ID of the thread that was run.

run_idstringRequired

The ID of the run to modify.

Body

metadataobject | nullableOptional

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.

Responses

200

OK

application/json

post

curlpythonjavascript

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"
    }
  }'

200

OK

{
  "id": "text",
  "object": "thread.run",
  "created_at": 1,
  "thread_id": "text",
  "assistant_id": "text",
  "status": "queued",
  "required_action": {
    "type": "submit_tool_outputs",
    "submit_tool_outputs": {
      "tool_calls": [
        {
          "id": "text",
          "type": "function",
          "function": {
            "name": "text",
            "arguments": "text"
          }
        }
      ]
    }
  },
  "last_error": {
    "code": "server_error",
    "message": "text"
  },
  "expires_at": 1,
  "started_at": 1,
  "cancelled_at": 1,
  "failed_at": 1,
  "completed_at": 1,
  "incomplete_details": {
    "reason": "max_completion_tokens"
  },
  "model": "text",
  "instructions": "text",
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "metadata": {},
  "usage": {
    "completion_tokens": 1,
    "prompt_tokens": 1,
    "total_tokens": 1
  },
  "temperature": 1,
  "top_p": 1,
  "max_prompt_tokens": 1,
  "max_completion_tokens": 1,
  "truncation_strategy": {
    "type": "auto",
    "last_messages": 1
  },
  "tool_choice": "none",
  "parallel_tool_calls": true,
  "response_format": "none"
}