Muse MuseConcept
Dashboard

Independent concept built on Meta's Model API. Not an official Meta product.

Messages schemas

View on dev.meta.ai (opens in a new tab)

The full schema and model definitions referenced by the Messages endpoints. Each endpoint page links here for the detailed shape of its request and response objects.

Schemas

Anthropic Base64 Source Param

Inline base64-encoded media.

FieldTypeRequiredDescription
typeenum ('base64')No
media_typestringYesMIME type of the data, such as image/png or application/pdf.
datastringYesBase64-encoded bytes.

Anthropic Cache Control Ephemeral Param

Prompt-cache breakpoint. Accepted to improve cache hit rates. Only the 5m TTL is supported.

FieldTypeRequiredDescription
typeenum ('ephemeral')Yes
ttlenum ('5m')No

Anthropic Citations Config Param

Document citation settings. Enabling citations is not supported.

FieldTypeRequiredDescription
enabledenum ('false')No

Anthropic Content Block

Anthropic Messages content block. Supported block types are text, image, video (Meta extension), document, tool_use, tool_result, server_tool_use, thinking, and redacted_thinking. cache_control prompt-cache controls are accepted to improve cache hit rates. Unsupported block types return an invalid_request_error.

FieldTypeRequiredDescription
typestringYesContent block discriminator, such as text, image, video, document, tool_use, or tool_result.

Anthropic Content Block Param

Input content block. A block type that a role does not support returns an invalid_request_error.

Type: AnthropicTextBlockParam | AnthropicImageBlockParam | AnthropicVideoBlockParam | AnthropicDocumentBlockParam | AnthropicSearchResultBlockParam | AnthropicToolUseBlockParam | AnthropicToolResultBlockParam | AnthropicServerToolUseBlockParam | AnthropicThinkingBlockParam | AnthropicRedactedThinkingBlockParam

Anthropic Content Source Block Param

A block of an inline-content document.

Type: AnthropicContentSourceTextBlockParam | AnthropicContentSourceOtherBlockParam

Anthropic Content Source Other Block Param

Any other block of an inline-content document, passed as its JSON text.

FieldTypeRequiredDescription
typestringYesAny block type except text.

Anthropic Content Source Param

Document built from inline content blocks.

FieldTypeRequiredDescription
typeenum ('content')No
contentstring | array of AnthropicContentSourceBlockParamYesA string, or an array of content blocks. Non-text blocks are passed as their JSON text.

Anthropic Content Source Text Block Param

A text block of an inline-content document.

FieldTypeRequiredDescription
typeenum ('text')Yes
textstringYes

Anthropic Count Tokens Request

FieldTypeRequiredDescription
modelstringYes(minLength: 1)
messagesarray of AnthropicInputMessageYes(minItems: 1)
systemstring | array of AnthropicSystemTextBlockParamNo
toolsarray of AnthropicToolNo
tool_choiceAnthropicToolChoiceNo
metadataAnthropicMetadataParamNo
temperaturenumberNo(minimum: 0, maximum: 1)
top_pnumberNo(minimum: 0, maximum: 1)
thinkingAnthropicThinkingConfigParamNo
service_tierenum ('auto', 'standard_only')No
cache_controlAnthropicCacheControlEphemeralParamNo
output_configAnthropicOutputConfigNo
max_tokensNoIgnored.
streamNoIgnored.

Anthropic Count Tokens Response

FieldTypeRequiredDescription
input_tokensintegerYesNumber of input tokens in the supplied Messages request.

Anthropic Custom Tool Param

A developer tool. type is omitted or custom.

FieldTypeRequiredDescription
typeenum ('custom')No
namestringYes
descriptionstring | nullNo
input_schemaobject | nullNoJSON Schema for the tool's input.
parametersNoParameter schema, read only for the client tool search tool named ToolSearch.
strictboolean | nullNo
defer_loadingboolean | nullNo
cache_controlAnthropicCacheControlEphemeralParamNo

Anthropic Direct Caller Param

The model invoked the tool directly.

FieldTypeRequiredDescription
typeenum ('direct')Yes

Anthropic Document Block Param

Document input.

FieldTypeRequiredDescription
typeenum ('document')No
sourceAnthropicDocumentSourceParamYes
titlestring | nullNo
contextstring | nullNo
citationsAnthropicCitationsConfigParamNo
cache_controlAnthropicCacheControlEphemeralParamNo

Anthropic Document Source Param

Document source.

Type: AnthropicBase64SourceParam | AnthropicPlainTextSourceParam | AnthropicContentSourceParam | AnthropicUrlSourceParam | AnthropicFileSourceParam

Anthropic File Source Param

Media referenced by an uploaded file ID.

FieldTypeRequiredDescription
typeenum ('file')No
file_idstringYes

Anthropic Image Block Param

Image input.

FieldTypeRequiredDescription
typeenum ('image')No
sourceAnthropicMediaSourceParamYes
cache_controlAnthropicCacheControlEphemeralParamNo

Anthropic Input Message

Anthropic Messages input message.

FieldTypeRequiredDescription
roleenum ('user', 'assistant', 'system', 'developer')Yes
contentstring | array of AnthropicContentBlockParamYes

Anthropic Json Output Format

Anthropic JSON structured-output format.

FieldTypeRequiredDescription
typeenum ('json_schema')Yes
schemaobjectYes

Anthropic Media Source Param

Image or video source.

Type: AnthropicBase64SourceParam | AnthropicUrlSourceParam | AnthropicFileSourceParam

Anthropic Message

Anthropic-compatible assistant message response.

FieldTypeRequiredDescription
idstringYes
typeenum ('message')Yes
roleenum ('assistant')Yes
contentarray of AnthropicContentBlockYes
modelstringYes
stop_reasonenum ('end_turn', 'max_tokens', 'stop_sequence', 'tool_use', 'pause_turn', 'refusal')Yes
stop_sequencestring | nullYes
usageAnthropicUsageYes

Anthropic Message Request

FieldTypeRequiredDescription
modelstringYes(minLength: 1)
messagesarray of AnthropicInputMessageYes(minItems: 1)
systemstring | array of AnthropicSystemTextBlockParamNo
toolsarray of AnthropicToolNo
tool_choiceAnthropicToolChoiceNo
metadataAnthropicMetadataParamNo
temperaturenumberNo(minimum: 0, maximum: 1)
top_pnumberNo(minimum: 0, maximum: 1)
thinkingAnthropicThinkingConfigParamNo
service_tierenum ('auto', 'standard_only')No
cache_controlAnthropicCacheControlEphemeralParamNo
output_configAnthropicOutputConfigNo
max_tokensintegerYes(minimum: 1)
streambooleanNo(default: false)

Anthropic Message Request Base

Anthropic Messages request accepted at /v1/messages. top_k, stop_sequences and inference_geo are not supported, so a request that sets them is rejected.

FieldTypeRequiredDescription
modelstringYes(minLength: 1)
messagesarray of AnthropicInputMessageYes(minItems: 1)
systemstring | array of AnthropicSystemTextBlockParamNo
toolsarray of AnthropicToolNo
tool_choiceAnthropicToolChoiceNo
metadataAnthropicMetadataParamNo
temperaturenumberNo(minimum: 0, maximum: 1)
top_pnumberNo(minimum: 0, maximum: 1)
thinkingAnthropicThinkingConfigParamNo
service_tierenum ('auto', 'standard_only')No
cache_controlAnthropicCacheControlEphemeralParamNo
output_configAnthropicOutputConfigNo

Anthropic Metadata Param

Request metadata. user_id identifies the end user; other string values are passed through.

FieldTypeRequiredDescription
user_idstringNo

Anthropic Output Config

Anthropic output controls. effort sets the reasoning effort; max selects the strongest available effort.

FieldTypeRequiredDescription
effortenum ('low', 'medium', 'high', 'xhigh', 'max')No
formatAnthropicJsonOutputFormatNo

Anthropic Plain Text Source Param

Plain-text document.

FieldTypeRequiredDescription
typeenum ('text')No
media_typeNoIgnored. Plain text is always text/plain.
datastringYes

Anthropic Redacted Thinking Block Param

Encrypted reasoning returned by an earlier response, replayed as is.

FieldTypeRequiredDescription
typeenum ('redacted_thinking')No
dataNoThe encrypted reasoning, as returned.
redacted_thinkingNoOlder name for data, read when data is absent.

Anthropic Search Result Block Param

Search result passed to the model as its JSON text.

FieldTypeRequiredDescription
typeenum ('search_result')No
sourceNoWhere the result came from.
titleNoResult title.
contentNoText blocks with the result content.
cache_controlAnthropicCacheControlEphemeralParamNo

Anthropic Server Tool Caller Param

What invoked the tool. Accepted and ignored.

Type: AnthropicDirectCallerParam

Anthropic Server Tool Use Block Param

Earlier server tool call, replayed. Supported names are web_search and tool_search.

FieldTypeRequiredDescription
typeenum ('server_tool_use')No
idstringYes
nameenum ('web_search', 'tool_search')Yes
inputAnthropicServerToolUseInputParamYes
cache_controlAnthropicCacheControlEphemeralParamNo
callerAnthropicServerToolCallerParamNo

Anthropic Server Tool Use Input Param

The call input, as returned.

FieldTypeRequiredDescription
queryNoThe search query.

Anthropic Stream Event

Anthropic Messages server-sent event. Stream event names include message_start, content_block_start, content_block_delta, content_block_stop, message_delta, message_stop, and error.

Type: object

Anthropic System Text Block Param

A system prompt text block.

FieldTypeRequiredDescription
typeenum ('text')Yes
textstringYes
citationsNoAccepted and ignored.
cache_controlAnthropicCacheControlEphemeralParamNo

Anthropic Text Block Param

Text content.

FieldTypeRequiredDescription
typeenum ('text')No
textstringYes
citationsNoAccepted and ignored.
cache_controlAnthropicCacheControlEphemeralParamNo

Anthropic Thinking Block Param

Earlier reasoning summary, replayed.

FieldTypeRequiredDescription
typeenum ('thinking')No
thinkingstringYes
signatureNoAccepted and ignored.

Anthropic Thinking Config Adaptive Param

The model decides how much to reason.

FieldTypeRequiredDescription
typeenum ('adaptive')No
displayenum ('summarized', 'omitted')No

Anthropic Thinking Config Disabled Param

Reasoning off, where the model supports it.

FieldTypeRequiredDescription
typeenum ('disabled')No

Anthropic Thinking Config Enabled Param

Reasoning with a token budget.

FieldTypeRequiredDescription
typeenum ('enabled')No
budget_tokensinteger (int64)YesReasoning token budget. Must be less than max_tokens. (minimum: 1024)
displayenum ('summarized', 'omitted')No

Anthropic Thinking Config Param

Extended reasoning settings.

Type: AnthropicThinkingConfigEnabledParam | AnthropicThinkingConfigAdaptiveParam | AnthropicThinkingConfigDisabledParam

Anthropic Tool

Anthropic tool definition. Custom (developer) tools are supported; supported hosted tools are accepted, and unsupported hosted tools return an invalid_request_error.

Type: AnthropicWebSearchToolParam | AnthropicToolSearchToolParam | AnthropicCustomToolParam

Anthropic Tool Choice

FieldTypeRequiredDescription
typeenum ('auto', 'any', 'none')Yes
nameNoIgnored.
disable_parallel_tool_usebooleanNo

Anthropic Tool Result Block Param

Result of an earlier tool call.

FieldTypeRequiredDescription
typeenum ('tool_result')No
tool_use_idstringYes
contentstring | array of AnthropicToolResultContentBlockParamNoA string, or an array of content blocks. Any other value is passed as its JSON text.
is_errorNotrue marks the result as an error.
cache_controlAnthropicCacheControlEphemeralParamNo

Anthropic Tool Result Content Block Param

A block of a tool result. Blocks other than text, image and document are passed as their JSON text.

Type: AnthropicContentSourceTextBlockParam | AnthropicToolResultImageBlockParam | AnthropicToolResultDocumentBlockParam | AnthropicToolResultOtherBlockParam

Anthropic Tool Result Document Block Param

A document in a tool result.

FieldTypeRequiredDescription
typeenum ('document')Yes
sourceAnthropicDocumentSourceParamYes
titlestring | nullNo
contextstring | nullNo
citationsAnthropicCitationsConfigParamNo

Anthropic Tool Result Image Block Param

An image in a tool result.

FieldTypeRequiredDescription
typeenum ('image')Yes
sourceAnthropicMediaSourceParamYes

Anthropic Tool Result Other Block Param

Any other block of a tool result, passed as its JSON text.

FieldTypeRequiredDescription
typestringNoAny block type except text, image and document.

Anthropic Tool Search Tool Param

The hosted tool search tool.

FieldTypeRequiredDescription
typeenum ('tool_search', 'tool_search_20250305')Yes
executionenum ('server', 'client') | nullNo
descriptionstring | nullNo
parametersobject | nullNoParameter schema for a client-executed tool search tool.
input_schemaNoUsed as parameters when parameters is omitted.
cache_controlAnthropicCacheControlEphemeralParamNo

Anthropic Tool Use Block Param

Earlier tool call, replayed.

FieldTypeRequiredDescription
typeenum ('tool_use')No
idstringYes
namestringYes
inputNoTool arguments, as an object.
cache_controlAnthropicCacheControlEphemeralParamNo

Anthropic Url Source Param

Media fetched from a URL.

FieldTypeRequiredDescription
typeenum ('url')No
urlstringYes

Anthropic Usage

FieldTypeRequiredDescription
input_tokensintegerYes
output_tokensintegerYes
cache_creation_input_tokensintegerNo
cache_read_input_tokensintegerNo
output_tokens_detailsobjectNo
output_tokens_details.thinking_tokensintegerNo

Anthropic User Location Param

Approximate user location for web search.

FieldTypeRequiredDescription
typeenum ('approximate')No
citystring | nullNo
regionstring | nullNo
countrystring | nullNo
timezonestring | nullNo

Anthropic Video Block Param

Video input (Meta extension).

FieldTypeRequiredDescription
typeenum ('video')No
sourceAnthropicMediaSourceParamYes
fpsnumber | nullNoFrames per second to sample.
cache_controlAnthropicCacheControlEphemeralParamNo

Anthropic Web Search Tool Param

The hosted web search tool.

FieldTypeRequiredDescription
typeenum ('web_search', 'web_search_20250305', 'web_search_20250305_15')Yes
user_locationAnthropicUserLocationParamNo
cache_controlAnthropicCacheControlEphemeralParamNo

Mirrored from dev.meta.ai/docs/api-reference/messages/schemas (synced Oct 30, 2026). Text and examples © Meta. Live demos run on Muse Muse's key.

Esc

Loading...