POST
/
v1
/
threads
/
{threadId}
/
runs
/
{runId}

Authorizations

X-Tune-Key
string
headerrequired

Tune API Keys are the preferred way to authenticate with the API. You can create an API Key from your Tune Studio Profile → 'Access Keys' (in sidebar)

Path Parameters

threadId
string
required

The ID of the thread that was run.

runId
string
required

The ID of the run to modify.

Body

application/json
metadata
object

Metadata to store additional information in key-value pairs.

Response

200 - application/json
id
string

The ID of the run.

object
string

"run".

createdAt
string

The time the run was created.

assistantId
string
threadId
string

The ID of the thread.

status
string

queued, in_progress, requires_action, cancelling, cancelled, failed, completed, or expired..

requiredAction
object
lastError
object
expiresAt
string

The time the run expires.

startedAt
string

The time the run started.

cancelledAt
string

The time the run was cancelled.

completedAt
string

The time the run was completed.

failedAt
string

The time the run failed.

model
string

The model used for the run.

instructions
string

The instructions for the run.

tools
object[]

The tools used in the run.

fileIds
string[]

The file IDs used in the run.

metadata
object

The metadata for the run.

usage
object