Sign in
Messages

Stop Message

Stops an in-flight assistant message generation. The agent aborts at the next safe point and the message is marked finished.

post/chats/{chatId}/messages/{messageId}/stop

Path parameters

chatIdstring required

The unique identifier of the chat.

messageIdstring required

The unique identifier of the assistant message to stop.

Response

The stopped message.

messageIdstring required

The unique identifier of the stopped message.

Changes

Changed in 4 of the 34 revisions of this API.915

  • 98b36164ce341See the full diff
    • ○

      added the non-success response with the status 422

      response-non-success-status-added

  • da68370a2aea813See the full diff
    • ▲

      for the path request parameter chatId, the minLength was increased from 0 to 1

      request-parameter-min-length-increased

    • ▲

      for the path request parameter messageId, the minLength was increased from 0 to 1

      request-parameter-min-length-increased

    • ▲

      removed the required property error from the response with the 401 status

      response-required-property-removed

    • ▲

      removed the required property error from the response with the 403 status

      response-required-property-removed

    • ▲

      removed the required property error from the response with the 404 status

      response-required-property-removed

    • ▲

      removed the required property error from the response with the 409 status

      response-required-property-removed

    • ▲

      removed the required property error from the response with the 500 status

      response-required-property-removed

    • ▲

      removed the required property success from the response with the 200 status

      response-required-property-removed

    • ○

      api operation id chats.stop removed and replaced with messages.stop

      api-operation-id-removed

    • ○

      the endpoint scheme security apiKey was removed from the API

      api-security-removed

    • ○

      api tag Messages added

      api-tag-added

    • ○

      api tag chats removed

      api-tag-removed

    • ○

      removed the non-success response with the status 413

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 422

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 429

      response-non-success-status-removed

    • ○

      added the required property message to the response with the 401 status

      response-required-property-added

    • ○

      added the required property message to the response with the 403 status

      response-required-property-added

    • ○

      added the required property message to the response with the 404 status

      response-required-property-added

    • ○

      added the required property message to the response with the 409 status

      response-required-property-added

    • ○

      added the required property message to the response with the 500 status

      response-required-property-added

    • ○

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

      response-required-property-added

    This revision also has 50 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 79811cd54faa1See the full diff
    • ○

      endpoint added

      endpoint-added

  • 3521652a43a71See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog