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

Authorizations

X-Tune-Key
string
header
required

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
assistantId
string
cancelledAt
string

The time the run was cancelled.

completedAt
string

The time the run was completed.

createdAt
string

The time the run was created.

expiresAt
string

The time the run expires.

failedAt
string

The time the run failed.

fileIds
string[]

The file IDs used in the run.

id
string

The ID of the run.

instructions
string

The instructions for the run.

lastError
object
metadata
object

The metadata for the run.

model
string

The model used for the run.

object
string

"run".

requiredAction
object
startedAt
string

The time the run started.

status
string

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

threadId
string

The ID of the thread.

tools
object[]

The tools used in the run.

usage
object