Sign in

Changed on
post/api/v1beta/me/messages/clienttoolresult

Request

  • The document declares no server URL.
  • Auth: bearer_auth (a scheme the document does not define)

Request body

chat_idstring uuid required

The chat whose suspended generation is awaiting this result.

errorstring

An error message if the client could not execute the tool. Provide this OR result.

file_upload_idsstring[]

Uploaded files to attach to the assistant message with rich previews and read with the normal file processor for this tool result. Each file is authorized before reading or attaching. Duplicate IDs are ignored; at most min(frontend.max_files, 20) unique files are considered.

message_idstring uuid required

The id of the assistant message whose generation emitted the client tool call. Disambiguates a result from a task that has since been replaced by a concurrent generation on the same chat.

resultunknown
tool_call_idstring required

The tool_call_id from the client_tool_call event being answered.

Example request

{
  "chat_id": "00000000-0000-0000-0000-000000000000",
  "message_id": "00000000-0000-0000-0000-000000000000"
}

Response

deliveredboolean required

True if a suspended generation received this result; false if it was a benign no-op (already delivered, timed out, aborted, or unknown id).

storedboolean required

True if this result settled a parked client operation, which the sender then continues.

Changes

  • a628ab508863Revision changes
    • info

      added the new optional request property /////

  • 9f0bebd2f5c9Revision changes
    • info

      added the required property to the response with the status