{"openapi":"3.0.0","info":{"description":"Meta Model API — Meta's hosted model API at api.meta.ai/v1: Muse Spark (agentic text, 1M-token context), Muse Image, Muse Voice Transcribe; OpenAI- and Anthropic-compatible","version":[{"name":"v1","value":"v1"}]},"servers":[{"description":"Meta Model API — Meta's hosted model API at api.meta.ai/v1: Muse Spark (agentic text, 1M-token context), Muse Image, Muse Voice Transcribe; OpenAI- and Anthropic-compatible","url":"https://api.apirails.com/metaai"}],"paths":{"/responses":{"post":{"tags":["Responses"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/responses/create-response","api_endpoint":"https://api.meta.ai/v1/responses"},"summary":"Create a response","description":"Generate a model response with Muse Spark models; optionally chain a previous response by ID for multi-turn server-managed state","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"object","description":"Text output format configuration (text, json_object, or json_schema)"},"background":{"type":"boolean","description":"Run the response asynchronously in the background (cannot combine with stream)","enum":[true,false]},"context_management":{"type":"array","description":"Context-management configuration items for the request","items":{"type":"string"}},"frequency_penalty":{"type":"number","description":"Penalizes tokens in proportion to how often they have appeared, reducing repetition (-2.0 to 2.0)"},"include":{"type":"array","description":"Additional output data to return (e.g. message.output_text.logprobs)","items":{"type":"string"}},"input":{"type":"string","description":"Input for the response: a text string or an array of input items (messages, content blocks, item references)","required":true},"instructions":{"type":"string","description":"Developer-level instructions inserted at the top of the model's context"},"max_output_tokens":{"type":"number","description":"Upper bound on generated tokens counting visible output and reasoning (minimum 16)"},"max_tool_calls":{"type":"number","description":"Maximum number of built-in tool calls allowed while generating the response, counted across all built-in tools"},"metadata":{"type":"object","description":"Key-value metadata to attach to the response (16 keys, 256 chars each)"},"model":{"type":"string","description":"Model ID (Muse Spark 1.3/1.2/1.1 (text+vision agentic models; -contributor tier variants))","required":true},"parallel_tool_calls":{"type":"boolean","description":"Whether the model may issue multiple tool calls in a single turn","enum":[true,false]},"presence_penalty":{"type":"number","description":"Penalizes tokens that have already appeared, nudging toward new topics (-2.0 to 2.0)"},"previous_response_id":{"type":"string","description":"Identifier of a previous response to continue from (multi-turn with server-managed state; cannot combine with conversation)"},"prompt":{"type":"object","description":"Prompt configuration (stored prompt id and variables)"},"prompt_cache_key":{"type":"string","description":"Groups similar requests to improve cache hit rates; replaces the user field"},"prompt_cache_retention":{"type":"string","description":"Retention policy for the prompt cache","enum":["in_memory","24h"]},"reasoning":{"type":"object","description":"Reasoning configuration object (effort and summary settings)"},"safety_identifier":{"type":"string","description":"Stable identifier that helps detect policy-violating users (up to 64 chars)"},"service_tier":{"type":"string","description":"Service tier for the request (auto, default, or flex)"},"store":{"type":"boolean","description":"Whether to persist the generated response so it can be retrieved and chained later","enum":[true,false]},"stream":{"type":"boolean","description":"Stream the response as server-sent events as it is generated (cannot combine with background)","enum":[true,false]},"temperature":{"type":"number","description":"Sampling temperature between 0 and 2 (higher = more random)"},"tool_choice":{"type":"string","description":"Tool choice: auto, none, required, or a named tool"},"tools":{"type":"array","description":"Tools the model may call (function and built-in tool definitions)","items":{"type":"string"}},"top_logprobs":{"type":"number","description":"Number of top alternative tokens (0-20) to return at each position with log probabilities"},"top_p":{"type":"number","description":"Nucleus sampling: only tokens whose cumulative probability is at most this value are considered (must be greater than 0)"},"truncation":{"type":"string","description":"Truncation strategy when context or replay limits are hit","enum":["auto","disabled"]},"user":{"type":"string","description":"End-user identifier (being replaced by safety_identifier and prompt_cache_key)"}}},"example":{"text":{},"background":"","context_management":[],"frequency_penalty":"","include":[],"input":"","instructions":"","max_output_tokens":"","max_tool_calls":"","metadata":{},"model":"","parallel_tool_calls":"","presence_penalty":"","previous_response_id":"","prompt":{},"prompt_cache_key":"","prompt_cache_retention":"","reasoning":{},"safety_identifier":"","service_tier":"","store":"","stream":"","temperature":"","tool_choice":"","tools":[],"top_logprobs":"","top_p":"","truncation":"","user":""}}}}}},"/responses/{response_id}":{"get":{"tags":["Responses"],"parameters":[{"name":"response_id","in":"path","description":"The ID of the response to retrieve","required":true,"schema":{"type":"string","example":""}},{"name":"starting_after","in":"query","description":"When streaming, only send events with a sequence number greater than this value (resume a stream)","required":false,"schema":{"type":"number","example":""}},{"name":"stream","in":"query","description":"If true, stream the response as server-sent events terminated by a data: [DONE] sentinel (in-progress background responses only)","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/responses/retrieve-response","api_endpoint":"https://api.meta.ai/v1/responses/{response_id}"},"summary":"Retrieve a response","description":"Retrieve a previously created response by its ID; in-progress background responses can be streamed as server-sent events","security":[{"bearerAuth":[]}]},"delete":{"tags":["Responses"],"parameters":[{"name":"response_id","in":"path","description":"The ID of the response to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/responses/delete-response","api_endpoint":"https://api.meta.ai/v1/responses/{response_id}"},"summary":"Delete a response","description":"Delete a previously created stored response by its ID","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/responses/{response_id}/cancel":{"post":{"tags":["Responses"],"parameters":[{"name":"response_id","in":"path","description":"The ID of the response to cancel","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/responses/cancel-response","api_endpoint":"https://api.meta.ai/v1/responses/{response_id}/cancel"},"summary":"Cancel a response","description":"Cancel an in-progress background response; only responses created with background true can be cancelled","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/responses/input_tokens":{"post":{"tags":["Responses"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/responses/count-input-tokens","api_endpoint":"https://api.meta.ai/v1/responses/input_tokens"},"summary":"Count response input tokens","description":"Count tokens in the fully rendered input for a Responses request (including resolved previous_response_id history, instructions, tools and server-injected scaffolding) without generating a response","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"object","description":"Text output format configuration"},"include":{"type":"array","description":"Additional output data included in the count","items":{"type":"string"}},"input":{"type":"string","description":"Input to count: a text string or an array of input items","required":true},"instructions":{"type":"string","description":"Developer-level instructions inserted at the top of the model's context"},"max_output_tokens":{"type":"number","description":"Upper bound on generated tokens (minimum 16)"},"model":{"type":"string","description":"Model ID (Muse Spark 1.3/1.2/1.1 (text+vision agentic models; -contributor tier variants))","required":true},"previous_response_id":{"type":"string","description":"Identifier of a previous response whose history is resolved into the count"},"reasoning":{"type":"object","description":"Reasoning configuration object (effort and summary settings)"},"tools":{"type":"array","description":"Tools included in the count","items":{"type":"string"}}}},"example":{"text":{},"include":[],"input":"","instructions":"","max_output_tokens":"","model":"","previous_response_id":"","reasoning":{},"tools":[]}}}}}},"/chat/completions":{"post":{"tags":["Chat Completions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/chat-completions/create-chat-completion","api_endpoint":"https://api.meta.ai/v1/chat/completions"},"summary":"Create a chat completion","description":"Generate a chat completion from an ordered message list (OpenAI-compatible)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"frequency_penalty":{"type":"number","description":"Penalizes tokens by frequency, reducing repetition (-2.0 to 2.0)"},"logprobs":{"type":"boolean","description":"When true, return the log probability of each token in the message content","enum":[true,false]},"max_completion_tokens":{"type":"number","description":"Upper bound on generated tokens counting visible output and reasoning"},"max_tokens":{"type":"number","description":"Maximum tokens to generate (deprecated in favor of max_completion_tokens)"},"messages":{"type":"array","description":"Ordered conversation messages, each with a role and content (user, assistant, system, developer, tool)","required":true,"items":{"type":"string"}},"metadata":{"type":"object","description":"Key-value metadata to attach to the completion"},"modalities":{"type":"array","description":"Output modalities requested","items":{"type":"string"}},"model":{"type":"string","description":"Model ID (Muse Spark 1.3/1.2/1.1 (text+vision agentic models; -contributor tier variants))","required":true},"n":{"type":"number","description":"Number of completions to generate; only n=1 is supported"},"parallel_tool_calls":{"type":"boolean","description":"Whether the model may issue multiple tool calls in a single turn","enum":[true,false]},"presence_penalty":{"type":"number","description":"Penalizes already-seen tokens, nudging toward new topics (-2.0 to 2.0)"},"prompt_cache_key":{"type":"string","description":"Groups similar requests to improve cache hit rates; replaces the user field"},"prompt_cache_retention":{"type":"string","description":"Retention policy for the prompt cache","enum":["in_memory","24h"]},"reasoning_effort":{"type":"string","description":"Reasoning effort for the completion (e.g. minimal, low, medium, high)"},"response_format":{"type":"object","description":"Output format constraint: text, json_object, or json_schema for Structured Outputs"},"safety_identifier":{"type":"string","description":"Stable identifier that helps detect policy-violating users (up to 64 chars)"},"seed":{"type":"number","description":"Best-effort deterministic sampling seed for repeated requests"},"service_tier":{"type":"string","description":"Service tier for the request (auto, default, or flex)"},"stop":{"type":"string","description":"Up to 4 sequences where the API stops generating further tokens (string or array)"},"store":{"type":"boolean","description":"Whether to store the output for distillation or evals products","enum":[true,false]},"stream":{"type":"boolean","description":"Stream the response incrementally as server-sent events","enum":[true,false]},"stream_options":{"type":"object","description":"Streaming options (include_usage)"},"temperature":{"type":"number","description":"Sampling temperature between 0 and 2 (higher = more random)"},"tool_choice":{"type":"string","description":"Tool choice: none, auto, required, or a specific tool"},"tools":{"type":"array","description":"Tools the model may call (custom or function tool definitions)","items":{"type":"string"}},"top_logprobs":{"type":"number","description":"Number of top alternative tokens (0-20) to return at each position when logprobs is enabled"},"top_p":{"type":"number","description":"Nucleus sampling: only tokens whose cumulative probability is at most this value are considered"},"user":{"type":"string","description":"End-user identifier (being replaced by safety_identifier and prompt_cache_key)"}}},"example":{"frequency_penalty":"","logprobs":"","max_completion_tokens":"","max_tokens":"","messages":[],"metadata":{},"modalities":[],"model":"","n":"","parallel_tool_calls":"","presence_penalty":"","prompt_cache_key":"","prompt_cache_retention":"","reasoning_effort":"","response_format":{},"safety_identifier":"","seed":"","service_tier":"","stop":"","store":"","stream":"","stream_options":{},"temperature":"","tool_choice":"","tools":[],"top_logprobs":"","top_p":"","user":""}}}}}},"/messages":{"post":{"tags":["Messages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/messages/create-message","api_endpoint":"https://api.meta.ai/v1/messages"},"summary":"Create a message","description":"Generate an Anthropic-compatible assistant message; accepts x-api-key or Authorization Bearer and returns an Anthropic-style envelope","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cache_control":{"type":"object","description":"Prompt caching cache_control blocks"},"container":{"type":"object","description":"Container configuration for code-execution tools"},"context_management":{"type":"object","description":"Context management configuration (context editing)"},"inference_geo":{"type":"string","description":"Geographic inference routing hint"},"max_tokens":{"type":"number","description":"Maximum number of tokens to generate","required":true},"messages":{"type":"array","description":"Ordered conversation messages, each with a role and content blocks","required":true,"items":{"type":"string"}},"metadata":{"type":"object","description":"Metadata about the request (user_id)"},"model":{"type":"string","description":"Model ID (Muse Spark 1.3/1.2/1.1 (text+vision agentic models; -contributor tier variants))","required":true},"output_config":{"type":"object","description":"Output configuration for the message"},"service_tier":{"type":"string","description":"Service tier for the request"},"stop_sequences":{"type":"array","description":"Sequences where the API stops generating further tokens","items":{"type":"string"}},"stream":{"type":"boolean","description":"Stream the response as server-sent events (Anthropic event format)","enum":[true,false]},"system":{"type":"string","description":"System prompt: a string or an array of content blocks"},"temperature":{"type":"number","description":"Sampling temperature (0-1 for Anthropic compatibility)"},"thinking":{"type":"object","description":"Extended thinking configuration (budget_tokens)"},"tool_choice":{"type":"object","description":"Tool choice configuration (auto, any, or a named tool)"},"tools":{"type":"array","description":"Tools the model may call (Anthropic tool definitions)","items":{"type":"string"}},"top_k":{"type":"number","description":"Only sample from the top K options for each token"},"top_p":{"type":"number","description":"Nucleus sampling parameter"}}},"example":{"cache_control":{},"container":{},"context_management":{},"inference_geo":"","max_tokens":"","messages":[],"metadata":{},"model":"","output_config":{},"service_tier":"","stop_sequences":[],"stream":"","system":"","temperature":"","thinking":{},"tool_choice":{},"tools":[],"top_k":"","top_p":""}}}}}},"/messages/count_tokens":{"post":{"tags":["Messages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/messages/count-tokens","api_endpoint":"https://api.meta.ai/v1/messages/count_tokens"},"summary":"Count message tokens","description":"Count input tokens for an Anthropic-compatible Messages request without generating a message (Anthropic-compatible)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cache_control":{"type":"object","description":"Prompt caching cache_control blocks"},"container":{"type":"object","description":"Container configuration for code-execution tools"},"context_management":{"type":"object","description":"Context management configuration (context editing)"},"inference_geo":{"type":"string","description":"Geographic inference routing hint"},"max_tokens":{"type":"number","description":"Maximum number of tokens to generate"},"messages":{"type":"array","description":"Ordered conversation messages, each with a role and content blocks","required":true,"items":{"type":"string"}},"metadata":{"type":"object","description":"Metadata about the request (user_id)"},"model":{"type":"string","description":"Model ID (Muse Spark 1.3/1.2/1.1 (text+vision agentic models; -contributor tier variants))","required":true},"output_config":{"type":"object","description":"Output configuration for the message"},"service_tier":{"type":"string","description":"Service tier for the request"},"stop_sequences":{"type":"array","description":"Sequences where the API stops generating further tokens","items":{"type":"string"}},"stream":{"type":"boolean","description":"Stream the response as server-sent events (Anthropic event format)","enum":[true,false]},"system":{"type":"string","description":"System prompt: a string or an array of content blocks"},"temperature":{"type":"number","description":"Sampling temperature (0-1 for Anthropic compatibility)"},"thinking":{"type":"object","description":"Extended thinking configuration (budget_tokens)"},"tool_choice":{"type":"object","description":"Tool choice configuration (auto, any, or a named tool)"},"tools":{"type":"array","description":"Tools the model may call (Anthropic tool definitions)","items":{"type":"string"}},"top_k":{"type":"number","description":"Only sample from the top K options for each token"},"top_p":{"type":"number","description":"Nucleus sampling parameter"}}},"example":{"cache_control":{},"container":{},"context_management":{},"inference_geo":"","max_tokens":"","messages":[],"metadata":{},"model":"","output_config":{},"service_tier":"","stop_sequences":[],"stream":"","system":"","temperature":"","thinking":{},"tool_choice":{},"tools":[],"top_k":"","top_p":""}}}}}},"/files":{"post":{"tags":["Files"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/files/upload-file","api_endpoint":"https://api.meta.ai/v1/files"},"summary":"Upload a file","description":"Upload a file for batch or user-data use (multipart/form-data); files can be referenced by Muse Spark inputs","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"expires_after":{"type":"object","description":"Expiration policy for the file","properties":{"anchor":{"type":"string","description":"The timestamp anchor for the expiration policy","required":true,"enum":["created_at"]},"seconds":{"type":"number","description":"Seconds after the anchor when the file expires","required":true}}},"file":{"type":"string","format":"binary","description":"The file to upload","required":true},"purpose":{"type":"string","description":"The intended purpose of the uploaded file (only user_data and batch supported)","required":true,"enum":["user_data","batch"]}}},"example":{"expires_after":{},"file":"(binary)","purpose":""}}}}},"get":{"tags":["Files"],"parameters":[{"name":"after","in":"query","description":"Pagination cursor: a file ID defining your place in the list","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Maximum number of files to return (1-10,000)","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"Sort direction by created_at","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"purpose","in":"query","description":"Return only files with this purpose","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/files/list-files","api_endpoint":"https://api.meta.ai/v1/files"},"summary":"List files","description":"List uploaded files with cursor pagination","security":[{"bearerAuth":[]}]}},"/files/{file_id}":{"get":{"tags":["Files"],"parameters":[{"name":"file_id","in":"path","description":"Identifier of the file (format file-<numeric>)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/files/retrieve-file","api_endpoint":"https://api.meta.ai/v1/files/{file_id}"},"summary":"Retrieve a file","description":"Retrieve metadata for an uploaded file","security":[{"bearerAuth":[]}]},"delete":{"tags":["Files"],"parameters":[{"name":"file_id","in":"path","description":"Identifier of the file to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/files/delete-file","api_endpoint":"https://api.meta.ai/v1/files/{file_id}"},"summary":"Delete a file","description":"Delete an uploaded file","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/files/{file_id}/content":{"get":{"tags":["Files"],"parameters":[{"name":"file_id","in":"path","description":"Identifier of the file to download","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/files/retrieve-file-content","api_endpoint":"https://api.meta.ai/v1/files/{file_id}/content"},"summary":"Retrieve file content","description":"Download the raw bytes of an uploaded file (application/octet-stream)","security":[{"bearerAuth":[]}]}},"/images/generations":{"post":{"tags":["Images"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/images/create-image","api_endpoint":"https://api.meta.ai/v1/images/generations"},"summary":"Generate an image","description":"Generate one or more images from a text prompt with Muse Image 1.0","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"model":{"type":"string","description":"Model ID for image generation (muse-image-1.0)","required":true},"moderation":{"type":"string","description":"Moderation level for the safety pipeline (auto, low, or none)"},"n":{"type":"number","description":"Number of images to generate (1-10, default 1)"},"output_format":{"type":"string","description":"Requested file type for the generated images (png, jpeg, or webp; default webp)"},"prompt":{"type":"string","description":"Text description of the images to generate","required":true},"reasoning_strength":{"type":"string","description":"How much reasoning the image generator applies before producing the image","enum":["low","high"]},"response_format":{"type":"string","description":"Format for returned images","enum":["url","b64_json"]},"size":{"type":"string","description":"Requested image shape as width x height (e.g. 1024x1024); sets the aspect ratio"},"stream":{"type":"boolean","description":"Stream the response as server-sent events (partial images then the completed image)","enum":[true,false]},"tool_enablement":{"type":"object","description":"Per-tool controls for the image generator's planner"},"user":{"type":"string","description":"Stable end-user identifier that helps detect and mitigate abuse"}}},"example":{"model":"","moderation":"","n":"","output_format":"","prompt":"","reasoning_strength":"","response_format":"","size":"","stream":"","tool_enablement":{},"user":""}}}}}},"/images/edits":{"post":{"tags":["Images"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/images/edit-image","api_endpoint":"https://api.meta.ai/v1/images/edits"},"summary":"Edit an image","description":"Edit or compose one or more input PNG images from a text prompt with Muse Image 1.0 (JSON body with base64 images; a multipart/form-data variant is also accepted)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"images":{"type":"array","description":"Images to edit (PNG, base64-encoded in JSON or file parts in multipart)","required":true,"items":{"type":"string"}},"model":{"type":"string","description":"Model ID for image editing (muse-image-1.0)","required":true},"moderation":{"type":"string","description":"Moderation level for the safety pipeline (auto, low, or none)"},"n":{"type":"number","description":"Number of edited images to generate (1-10, default 1)"},"output_format":{"type":"string","description":"Requested file type for the edited images (png, jpeg, or webp; default webp)"},"prompt":{"type":"string","description":"Text description of the edits to apply","required":true},"reasoning_strength":{"type":"string","description":"How much reasoning the image generator applies before producing the edited image","enum":["low","high"]},"response_format":{"type":"string","description":"Format for the edited images","enum":["url","b64_json"]},"size":{"type":"string","description":"Requested image shape as width x height; sets the aspect ratio"},"stream":{"type":"boolean","description":"Stream the response as server-sent events","enum":[true,false]},"tool_enablement":{"type":"object","description":"Per-tool controls for the image generator's planner"},"user":{"type":"string","description":"Stable end-user identifier that helps detect and mitigate abuse"}}},"example":{"images":[],"model":"","moderation":"","n":"","output_format":"","prompt":"","reasoning_strength":"","response_format":"","size":"","stream":"","tool_enablement":{},"user":""}}}}}},"/asr/transcribe":{"post":{"tags":["Audio"],"parameters":[{"name":"sessionId","in":"query","description":"Correlation id used in server-side logs and echoed in the response; generated by the server when omitted","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/voice/transcribe","api_endpoint":"https://api.meta.ai/v1/asr/transcribe"},"summary":"Transcribe a recording","description":"Transcribe a complete audio recording with Muse Voice Transcribe 1.0 (multipart/form-data: JSON request part + WAV audio part; max 32 MB and 10 minutes)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"audio":{"type":"string","format":"binary","description":"RIFF/WAVE audio: mono 16-bit integer PCM at 16 or 24 kHz (max 32 MB, 10 minutes)","required":true},"request":{"type":"object","description":"Transcription request parameters (JSON part)","required":true,"properties":{"audioEncoding":{"type":"string","description":"Container of the uploaded audio part","required":true,"enum":["WAV"]},"emitAudioProgress":{"type":"boolean","description":"Emit audioProgress events (event-stream responses only)"},"keywords":{"type":"array","description":"Terms to bias recognition toward (names, jargon, product words)"},"languageBias":{"type":"array","description":"Languages to bias transcription toward (language names)"},"mode":{"type":"string","description":"Transcription behavior (single-turn or multi-turn endpointing/diarization)","enum":["PUSH_TO_TALK","ENDPOINTING","DIARIZATION"]},"model":{"type":"string","description":"Model ID (muse-voice-transcribe-1.0); must support the requested mode","required":true},"partialMode":{"type":"string","description":"Representation of partial transcript text in event-stream responses","enum":["CUMULATIVE","DELTA"]}}}}},"example":{"audio":"(binary)","request":{}}}}}}},"/models":{"get":{"tags":["Models"],"parameters":[{"name":"client","in":"query","description":"Optional client-specific model catalog view","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/models/list-models","api_endpoint":"https://api.meta.ai/v1/models"},"summary":"List models","description":"List the models available to your API key (Muse Spark, Muse Image, Muse Voice Transcribe families)","security":[{"bearerAuth":[]}]}},"/models/{model}":{"get":{"tags":["Models"],"parameters":[{"name":"model","in":"path","description":"The ID of the model to retrieve (e.g. muse-spark-1.3)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/models/retrieve-model","api_endpoint":"https://api.meta.ai/v1/models/{model}"},"summary":"Retrieve a model","description":"Retrieve metadata for a single model","security":[{"bearerAuth":[]}]}},"/status":{"get":{"tags":["Status"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://dev.meta.ai/docs/api-reference/status","api_endpoint":"https://api.meta.ai/v1/status"},"summary":"Get API status","description":"Get overall API status and public model health; does not require authentication","security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}