检索消息

Retrieve a message.

get

https://api.portkey.ai/v1SELF_HOSTED_GATEWAY_URL

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

Authorizations

Portkey-Key & Virtual-KeyPortkey-Key & Provider-Auth & Provider-NameConfig & Portkey-KeyCustom-Host & Portkey-Key & Provider-Auth & Provider-Name

x-portkey-api-keystringRequired

x-portkey-virtual-keystringRequired

Path parameters

thread_idstringRequired

The ID of the thread to which this message belongs.

message_idstringRequired

The ID of the message to retrieve.

Responses

200

OK

application/json

Represents a message within a thread.

idstringRequired

The identifier, which can be referenced in API endpoints.

objectstring · enumRequired

The object type, which is always thread.message.

Possible values:

created_atintegerRequired

The Unix timestamp (in seconds) for when the message was created.

thread_idstringRequired

The thread ID that this message belongs to.

statusstring · enumRequired

The status of the message, which can be either in_progress, incomplete, or completed.

Possible values:

completed_atinteger · nullableRequired

The Unix timestamp (in seconds) for when the message was completed.

incomplete_atinteger · nullableRequired

The Unix timestamp (in seconds) for when the message was marked as incomplete.

rolestring · enumRequired

The entity that produced the message. One of user or assistant.

Possible values:

assistant_idstring · nullableRequired

If applicable, the ID of the assistant that authored this message.

run_idstring · nullableRequired

The ID of the run associated with the creation of this message. Value is null when messages are created manually using the create message or create thread endpoints.

metadataobject · nullableRequired

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 maxium of 512 characters long.

get

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

curlpythonjavascript

curl https://api.portkey.ai/v1/threads/thread_abc123/messages/msg_abc123 \
  -H "Content-Type: application/json" \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \
  -H "OpenAI-Beta: assistants=v2"

200

OK

{
  "id": "text",
  "object": "thread.message",
  "created_at": 1,
  "thread_id": "text",
  "status": "in_progress",
  "incomplete_details": {
    "reason": "content_filter"
  },
  "completed_at": 1,
  "incomplete_at": 1,
  "role": "user",
  "content": [
    {
      "type": "image_file",
      "image_file": {
        "file_id": "text",
        "detail": "auto"
      }
    }
  ],
  "assistant_id": "text",
  "run_id": "text",
  "attachments": [
    {
      "file_id": "text",
      "tools": [
        {
          "type": "code_interpreter"
        }
      ]
    }
  ],
  "metadata": {}
}