/ 
OpenAPI-Client-OpenAI-0.21
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}.

PATHS

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:

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 (See the OpenAI spec for more detail):

    {
  "id": "msg_abc123",
  "object": "thread.message",
  "created_at": 1698983503,
  "thread_id": "thread_abc123",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": {
        "value": "Hi! How can I help you today?",
        "annotations": []
      }
    }
  ],
  "assistant_id": "asst_abc123",
  "run_id": "run_abc123",
  "attachments": [],
  "metadata": {}
}

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 (See the OpenAI spec for more detail):

    {
  "id": "msg_abc123",
  "object": "thread.message",
  "created_at": 1698983503,
  "thread_id": "thread_abc123",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": {
        "value": "Hi! How can I help you today?",
        "annotations": []
      }
    }
  ],
  "assistant_id": "asst_abc123",
  "run_id": "run_abc123",
  "attachments": [],
  "metadata": {}
}

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.