/ 
OpenAPI-Client-OpenAI-0.20
River stage zero No dependents
/ OpenAPI::Client::OpenAI::Path::threads-thread_id-messages-message_id

NAME

OpenAPI::Client::OpenAI::Path::threads-thread_id-messages-message_id - Documentation for the /threads/{thread_id}/messages/{message_id} path.

DESCRIPTION

This document describes the API endpoint at /threads/{thread_id}/messages/{message_id}.

See the examples/ directory in the distribution for examples of how to use this.

DELETE /threads/{thread_id}/messages/{message_id}

Deletes a message.

Operation ID

deleteMessage

$client->deleteMessage( ... );

Parameters

  • thread_id (in path) (Required) - The ID of the thread to which this message belongs. Type: string

  • message_id (in path) (Required) - The ID of the message to delete. Type: string

Responses

Status Code: 200

OK

Content Types:

  • application/json

GET /threads/{thread_id}/messages/{message_id}

Retrieve a message.

Operation ID

getMessage

$client->getMessage( ... );

Parameters

  • thread_id (in path) (Required) - The ID of the [thread](/docs/api-reference/threads) to which this message belongs. Type: string

  • message_id (in path) (Required) - The ID of the message to retrieve. Type: string

Responses

Status Code: 200

OK

Content Types:

  • application/json

    Example:

    {
   "attachments" : [
      {
         "tools" : [
            null
         ]
      }
   ],
   "incomplete_details" : null,
   "content" : [
      null
   ]
}

POST /threads/{thread_id}/messages/{message_id}

Modifies a message.

Operation ID

modifyMessage

$client->modifyMessage( ... );

Parameters

  • thread_id (in path) (Required) - The ID of the thread to which this message belongs. Type: string

  • message_id (in path) (Required) - The ID of the message to modify. Type: string

Request Body

Content Type: application/json

Responses

Status Code: 200

OK

Content Types:

  • application/json

    Example:

    {
   "attachments" : [
      {
         "tools" : [
            null
         ]
      }
   ],
   "content" : [
      null
   ],
   "incomplete_details" : null
}

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.