Assistants

Cancel a run

Cancels a run that is in_progress.

post/threads/{thread_id}/runs/{run_id}/cancel

Path parameters

thread_idstring required

The ID of the thread to which this run belongs.

run_idstring required

The ID of the run to cancel.

Response

idstring required

The identifier, which can be referenced in API endpoints.

object'thread.run' required

The object type, which is always thread.run.

created_atinteger required

The Unix timestamp (in seconds) for when the run was created.

thread_idstring required

The ID of the thread that was executed on as a part of this run.

assistant_idstring required

The ID of the assistant used for execution of this run.

The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired.

expires_atinteger nullable required

The Unix timestamp (in seconds) for when the run will expire.

started_atinteger nullable required

The Unix timestamp (in seconds) for when the run was started.

cancelled_atinteger nullable required

The Unix timestamp (in seconds) for when the run was cancelled.

failed_atinteger nullable required

The Unix timestamp (in seconds) for when the run failed.

completed_atinteger nullable required

The Unix timestamp (in seconds) for when the run was completed.

modelstring required

The model that the assistant used for this run.

instructionsstring required

The instructions that the assistant used for this run.

metadataMetadata nullable required

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, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

temperaturenumber nullable

The sampling temperature used for this run. If not set, defaults to 1.

top_pnumber nullable

The nucleus sampling value used for this run. If not set, defaults to 1.

max_prompt_tokensinteger nullable required

The maximum number of prompt tokens specified to have been used over the course of the run.

max_completion_tokensinteger nullable required

The maximum number of completion tokens specified to have been used over the course of the run.

parallel_tool_callsboolean required

Whether to enable parallel function calling during tool use.

Changes

Changed in 10 of the 163 revisions of this API.21226

Sep 3, 20269430b00d75b41See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Aug 14, 20266ac2618eefd71See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
May 13, 202674cbcf73838f83See the full diff
- ▲
  response property metadata list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property response_format/oneOf[subschema #4: JSON schema]/json_schema/strict list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tools/items/oneOf[subschema #3: Function tool]/function/strict list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property truncation_strategy/allOf[subschema #1: Thread Truncation Controls]/last_messages list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ○
  added subschema #1 subschema #2 to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  the response's property default value false was removed for the status
  response-property-default-value-removed
- ○
  the response's property default value false was removed for the status
  response-property-default-value-removed
This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 11, 20256ab43fe7798e21See the full diff
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  added subschema #1 to the response property oneOf list for the response status
  response-property-one-of-added
- ○
  removed subschema #2 from the response property allOf list for the response status
  response-property-all-of-removed
Jan 31, 2025fc164a27fdb9215See the full diff
- ▲
  the response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added subschema #2 to the response property allOf list for the response status
  response-property-all-of-added
- ○
  added subschema #2 to the response property allOf list for the response status
  response-property-all-of-added
- ○
  added subschema #2 to the response property allOf list for the response status
  response-property-all-of-added
- ○
  removed subschema #1 from the response property oneOf list for the response status
  response-property-one-of-removed
- ○
  removed subschema #1 from the response property oneOf list for the response status
  response-property-one-of-removed
Jan 31, 202515156e46769c65See the full diff
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  added subschema #1 to the response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added subschema #1 to the response property oneOf list for the response status
  response-property-one-of-added
- ▲
  the response's property type changed from no type to object for status
  response-property-type-changed
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  removed subschema #2 from the response property allOf list for the response status
  response-property-all-of-removed
- ○
  removed subschema #2 from the response property allOf list for the response status
  response-property-all-of-removed
- ○
  removed subschema #2 from the response property allOf list for the response status
  response-property-all-of-removed
- ○
  added the required property / to the response with the status
  response-required-property-added
Jan 22, 2025bdebcdfcbbde215See the full diff
- ▲
  the response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added subschema #2 to the response property allOf list for the response status
  response-property-all-of-added
- ○
  added subschema #2 to the response property allOf list for the response status
  response-property-all-of-added
- ○
  added subschema #2 to the response property allOf list for the response status
  response-property-all-of-added
- ○
  removed subschema #1 from the response property oneOf list for the response status
  response-property-one-of-removed
- ○
  removed subschema #1 from the response property oneOf list for the response status
  response-property-one-of-removed
Sep 13, 20244c9e3967c7071See the full diff
- ○
  the response property ///// became required for the status
  response-property-became-required
Aug 23, 20245856f8b0c8501See the full diff
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Aug 6, 20248eca3b09b70513See the full diff
- ▲
  added to the response property oneOf list for the response status
  response-property-one-of-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  removed the none enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed from the response property oneOf list for the response status
  response-property-one-of-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history