Skip to main content
GET
Retrieve a message

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

messageID
string
required

Message ID returned by POST /v1/messages or X-Sail-Message-Id.

Response

Current message status or completed message output.

id
string
required
type
enum<string>
required
Available options:
message
status
enum<string>
required
Available options:
queued,
in_progress,
completed,
failed,
cancelled
role
enum<string>
Available options:
assistant
content
object[]
model
string
stop_reason
enum<string>
Available options:
end_turn,
max_tokens,
tool_use,
stop_sequence,
refusal,
model_context_window_exceeded
stop_sequence
string | null
usage
object
error
object
service_tier
enum<string>

The completion window Sail selected for this request, including when no window was requested. The legacy request value standard is reported as balanced. Older stored responses may omit this field.

Available options:
asap,
balanced,
flex