Sign in
Assistants

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

OK

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.

status'queued' | 'in_progress' | 'requires_action' | 'cancelling' | 'cancelled' | 'failed' | 'completed' | 'incomplete' | 'expired' required

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.

metadataobject 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. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

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 8 of the 35 revisions of this API.329

  • b60d5559d51522See the full diff
    • ▲

      added subschema #1: Behavior to the response_format response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added subschema #1: Behavior to the tool_choice response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      removed subschema #1 from the response_format response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed subschema #1 from the tool_choice response property oneOf list for the response status 200

      response-property-one-of-removed

  • 501122aa32ad1See the full diff
    • ○

      the response property tools/items/oneOf[subschema #2: FileSearch tool]/file_search/ranking_options/score_threshold became required for the status 200

      response-property-became-required

  • 1dbac0e95bdb1See the full diff
    • ○

      added the optional property tools/items/oneOf[subschema #2: FileSearch tool]/file_search/ranking_options to the response with the 200 status

      response-optional-property-added

  • 4097c2f86beb11See the full diff
    • ▲

      added ResponseFormatText ResponseFormatJsonObject ResponseFormatJsonSchema to the response_format response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      removed AssistantsApiResponseFormat from the response_format response property oneOf list for the response status 200

      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

  • c36d30a9462212See the full diff
    • ●

      added the new json_schema enum value to the response_format/oneOf[AssistantsApiResponseFormat]/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property tools/items/oneOf[subschema #3: Function tool]/function/strict to the response with the 200 status

      response-optional-property-added

    • ○

      removed the none enum value from the response_format/oneOf[subschema #1]/ response property for the response status 200

      response-property-enum-value-removed

  • ff436357b1231See the full diff
    • ○

      added the required property parallel_tool_calls to the response with the 200 status

      response-required-property-added

  • 0577fd0d08da1See the full diff
    • ○

      added the optional property tools/items/oneOf[subschema #2: FileSearch tool]/file_search to the response with the 200 status

      response-optional-property-added

  • 363dd904e5d61See the full diff
    • ●

      added the new incomplete enum value to the status response property for the response status 200

      response-property-enum-value-added