Create thread and run

POST /threads/runs

cURL

cURL

curl --request POST \
  --url https://aigw.portkey.ai/v1/threads/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_id": "<string>",
  "thread": {
    "messages": [
      {
        "content": "<string>",
        "attachments": [
          {
            "file_id": "<string>",
            "tools": [
              {
                "type": "code_interpreter"
              }
            ]
          }
        ],
        "metadata": {}
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      },
      "file_search": {
        "vector_store_ids": [
          "<string>"
        ],
        "vector_stores": [
          {
            "file_ids": [
              "<string>"
            ],
            "chunking_strategy": {
              "type": "auto"
            },
            "metadata": {}
          }
        ]
      }
    },
    "metadata": {}
  },
  "model": "<string>",
  "instructions": "<string>",
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "tool_resources": {
    "code_interpreter": {
      "file_ids": []
    },
    "file_search": {
      "vector_store_ids": [
        "<string>"
      ]
    }
  },
  "metadata": {},
  "temperature": 1,
  "top_p": 1,
  "stream": true,
  "max_prompt_tokens": 257,
  "max_completion_tokens": 257,
  "truncation_strategy": {
    "last_messages": 2
  },
  "parallel_tool_calls": true
}
'

200

{
  "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
  },
  "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",
  "temperature": 123,
  "top_p": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

assistant_id · string · required

thread · object

Show child attributes

model · string enum<string>

instructions · string | null

tools · (Code interpreter tool · object | FileSearch tool · object | Function tool · object)[] | null

Maximum array length: 20

Code interpreter tool

FileSearch tool

Function tool

Show child attributes

tool_resources · object | null

Show child attributes

metadata · object | null

temperature · number | null · default: 1

Required range: 0 <= x <= 2

top_p · number | null · default: 1

Required range: 0 <= x <= 1

stream · boolean | null

max_prompt_tokens · integer | null

Required range: x >= 256

max_completion_tokens · integer | null

Required range: x >= 256

truncation_strategy · Thread Truncation Controls · object | null

Show child attributes

tool_choice · enum<string> object

Available options: none, auto, required

parallel_tool_calls · boolean · default: true

response_format · enum<string> object

Available options: none, auto

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

Show child attributes

last_error · object | null · required

Show child attributes

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

Show child attributes

model · string · required

instructions · string · required

tools · (Code interpreter tool · object | FileSearch tool · object | Function tool · object)[] · required

Maximum array length: 20

Code interpreter tool

FileSearch tool

Function tool

Show child attributes

metadata · object | null · required

usage · object | null · required

Show child attributes

max_prompt_tokens · integer | null · required

Required range: x >= 256

max_completion_tokens · integer | null · required

Required range: x >= 256

truncation_strategy · Thread Truncation Controls · object | null · required

Show child attributes

tool_choice · enum<string> object · required

Available options: none, auto, required

parallel_tool_calls · boolean · default: true · required

response_format · enum<string> object · required

Available options: none, auto

temperature · number | null

top_p · number | null