Meta Model API

Start here

Overview
Quickstart
Authentication
Models
SDKs and libraries
Pricing and rate limits

Capabilities

Tool calling
Tool search
Search grounding
Image understanding
Video understanding
File handling
Reasoning
Structured output
Prompt caching
Token counting

Protocols

Choosing an API
Responses API
Chat Completions API
Messages API

Cookbook

All recipes
API fundamentals
Agent patterns
Use cases
Building with Muse Code

Muse Code

Overview
Authentication and billing
Permissions and safety
Working with the agent
Configuration and context
Extending and automating

Muse Glimmer

Overview
Get the model
Prompting guide
Quantization
Speculative decoding
Run inference
Customization

Agent guides

Coding agents
Agent frameworks
Computer use

API reference

Introduction
Error handling
Status
Responses
Chat completions
Messages
Files
Models

Log in

--- meta: title: Meta Model API cookbook description: Working recipes for building on Meta Model API — API primitives, agent loops, and end-to-end use cases on Muse Spark. keywords: cookbook, recipes, Meta Model API, agents, tool calling, Muse Spark cms: layout: large alias: /model-api/docs/cookbook target: aidmc copy_markdown: false github_url: https://github.com/meta-models/meta-model-cookbook --- # Meta Model API cookbook Ship on Muse Spark with recipes that run the first time you copy them. Each recipe solves one focused problem, shows working code, and points to what's next. Start with API fundamentals to nail the primitives, then layer on agent loops and full use cases. ## API fundamentals {#api-fundamentals} Validate one building block at a time and walk away with a starter you can extend. <tile-group col="3"> <tile color="blue" icon="cube" href="/docs/cookbook/quickstart-chat-completions" title="Quickstart: chat completions"> Point the OpenAI SDK at a new base URL and make your first Muse Spark call.</tile> <tile color="blue" icon="cube" href="/docs/cookbook/streaming-responses" title="Streaming responses"> Stream tokens as they generate and read usage in the final chunk.</tile> <tile color="blue" icon="cube" href="/docs/cookbook/tool-function-calling" title="Tool and function calling"> Detect a tool call, execute it, and feed the result back into the loop.</tile> <tile color="blue" icon="cube" href="/docs/cookbook/structured-output" title="Structured output"> Return JSON that matches your schema and parses on the first try.</tile> <tile color="blue" icon="cube" href="/docs/cookbook/prompt-caching" title="Prompt caching"> Reuse a stable prompt prefix and measure cached tokens.</tile> <tile color="blue" icon="cube" href="/docs/cookbook/reasoning-thinking-tokens" title="Reasoning and thinking tokens"> Set reasoning effort and replay reasoning across turns.</tile> <tile color="blue" icon="cube" href="/docs/cookbook/vision-input" title="Vision input"> Send images by URL or base64 and get structured analysis back.</tile> <tile color="blue" icon="cube" href="/docs/cookbook/long-context" title="Long context"> Pack repo-scale context into a single context window.</tile> <tile color="blue" icon="cube" href="/docs/cookbook/error-handling-retry" title="Error handling and retry"> Back off with jitter and skip retries on client errors.</tile> <tile color="blue" icon="cube" href="/docs/cookbook/search-grounding" title="Search grounding"> Ground answers in live web search with inline citations.</tile> </tile-group> ## Agent patterns Turn a model into an agent. These loops handle planning, self-correction, and staying coherent across long runs. <tile-group col="3"> <tile color="purple" icon="robot-head" href="/docs/cookbook/basic-agent-loop" title="Basic agent loop"> Wire up the core perceive-decide-act loop.</tile> <tile color="purple" icon="robot-head" href="/docs/cookbook/interleaved-reasoning-tool-use" title="Interleaved reasoning and tool use"> Interleave reasoning with tool calls in a single turn.</tile> <tile color="purple" icon="robot-head" href="/docs/cookbook/multi-turn-context-management" title="Multi-turn context management"> Keep context under control across a long agent run.</tile> <tile color="purple" icon="robot-head" href="/docs/cookbook/search-and-replace-edits" title="Search-and-replace edits"> Make exact-match file edits that stay reviewable.</tile> <tile color="purple" icon="robot-head" href="/docs/cookbook/alert-fatigue-copilot" title="Alert fatigue copilot"> Pull grounded patterns from noisy alerts, then probe, chat, and self-assess with strict JSON.</tile> </tile-group> ## Use cases {#use-cases} Build end-to-end: multimodal perception, orchestration, and complete apps you can adapt. <tile-group col="3"> <tile color="orange" icon="sparkle-diamond" href="/docs/cookbook/perception-chart-analysis" title="Chart analysis"> Read charts and extract structured data from images.</tile> <tile color="orange" icon="sparkle-diamond" href="/docs/cookbook/perception-error-screenshot-fix" title="Error screenshot fix"> Diagnose a bug from a screenshot and ship the fix.</tile> <tile color="orange" icon="sparkle-diamond" href="/docs/cookbook/rayban-openclaw" title="Smart glasses with OpenClaw"> Look, ask out loud, and hear the answer — hands-free on Ray-Ban Meta glasses.</tile> <tile color="orange" icon="sparkle-diamond" href="/docs/cookbook/generating-slides" title="Generating slides"> Generate a slide deck from a prompt or source content.</tile> <tile color="orange" icon="sparkle-diamond" href="/docs/cookbook/browser-verified-web-design" title="Browser-verified web design"> Build a website with a coding agent that checks its own work in a real browser.</tile> <tile color="orange" icon="sparkle-diamond" href="/docs/cookbook/iterative-game-dev" title="Iterative game dev"> Build a browser game end-to-end with a coding agent, verified in a real browser.</tile> <tile color="orange" icon="sparkle-diamond" href="/docs/cookbook/sandboxed-execution" title="Sandboxed execution"> Execute model-generated code in a sandbox.</tile> <tile color="orange" icon="sparkle-diamond" href="/docs/cookbook/multi-agent-orchestration" title="Multi-agent orchestration"> Orchestrate a team of specialists that coordinate through a shared Kanban board.</tile> <tile color="orange" icon="sparkle-diamond" href="/docs/cookbook/one-shot-game-dev" title="One-shot game dev"> Build a complete 3D browser game in one pass — one structured prompt, no iteration loop.</tile> <tile color="orange" icon="sparkle-diamond" href="/docs/cookbook/perception-grounding" title="Perception grounding"> Pin interactive dots at object pixel locations and generate a self-contained HTML overlay.</tile> <tile color="orange" icon="sparkle-diamond" href="/docs/cookbook/github-agent" title="GitHub agent"> Run an autonomous GitHub Actions bot for triage, PR review, and bug-fix PRs on OpenCode and Muse Spark.</tile> <tile color="orange" icon="sparkle-diamond" href="/docs/cookbook/computer-use" title="Computer use"> Control a desktop from screenshots with a computer-use agent.</tile> <tile color="orange" icon="sparkle-diamond" href="/docs/cookbook/computer-use-macos" title="Computer use on macOS"> Drive a real Mac from screenshots with native mouse and keyboard events.</tile> </tile-group> ## Building with Muse Code {#building-with-muse-code} Build durable, auditable agents with Muse Code — the harness building blocks for safety, recovery, and orchestration. <tile-group col="3"> <tile color="purple" icon="robot-head" href="/docs/cookbook/audit-agent-sessions" title="Audit and resume agent sessions"> Replay any session exactly as it ran from an append-only event log, show who authorized each action, then kill the run mid-task and resume with no duplicate side effects.</tile> <tile color="purple" icon="robot-head" href="/docs/cookbook/deterministic-replay" title="Deterministic replay in CI"> Turn recorded events into a golden fixture and replay its model-context projection as a merge-blocking CI check.</tile> <tile color="purple" icon="robot-head" href="/docs/cookbook/staged-approvals" title="Staged approvals"> Split a compound shell command into stages so safe ones auto-resolve while risky ones hold for review.</tile> <tile color="purple" icon="robot-head" href="/docs/cookbook/contained-execution" title="Contained execution"> Run every command in an OS sandbox that refuses to proceed unless containment is proven live.</tile> <tile color="purple" icon="robot-head" href="/docs/cookbook/immutable-guardrails" title="Immutable guardrails"> The agent can't rewrite its own rules: guardrail edits stop for review and a shell write to the same path fails read-only at the sandbox.</tile> <tile color="purple" icon="robot-head" href="/docs/cookbook/subagent-fanout" title="Subagent fanout"> Fan one job out to parallel subagents, each in its own isolated git worktree.</tile> <tile color="purple" icon="robot-head" href="/docs/cookbook/goal-tracking" title="Goal tracking"> Pin an objective once and the harness audits the work against acceptance checks before the goal can close.</tile> <tile color="purple" icon="robot-head" href="/docs/cookbook/bundled-skills" title="Bundled skills"> Drive the built-in /plan, /grilling, /grill-with-docs, and /taste skills to plan, pressure-test, and build.</tile> <tile color="purple" icon="robot-head" href="/docs/cookbook/loop-and-cron" title="Loop and cron"> Schedule recurring or one-time agent work in natural language, then view, change, or cancel it from the same chat.</tile> <tile color="purple" icon="robot-head" href="/docs/cookbook/side-chats" title="Side chats"> Branch off the main thread for a side conversation that never enters the main history.</tile> </tile-group>
Open in GitHub

Meta Model API cookbook

Ship on Muse Spark with recipes that run the first time you copy them. Each recipe solves one focused problem, shows working code, and points to what's next. Start with API fundamentals to nail the primitives, then layer on agent loops and full use cases.

API fundamentals

Validate one building block at a time and walk away with a starter you can extend.
Quickstart: chat completions Point the OpenAI SDK at a new base URL and make your first Muse Spark call.
Streaming responses Stream tokens as they generate and read usage in the final chunk.
Tool and function calling Detect a tool call, execute it, and feed the result back into the loop.
Structured output Return JSON that matches your schema and parses on the first try.
Prompt caching Reuse a stable prompt prefix and measure cached tokens.
Reasoning and thinking tokens Set reasoning effort and replay reasoning across turns.
Vision input Send images by URL or base64 and get structured analysis back.
Long context Pack repo-scale context into a single context window.
Error handling and retry Back off with jitter and skip retries on client errors.
Search grounding Ground answers in live web search with inline citations.

Agent patterns

Turn a model into an agent. These loops handle planning, self-correction, and staying coherent across long runs.
Basic agent loop Wire up the core perceive-decide-act loop.
Interleaved reasoning and tool use Interleave reasoning with tool calls in a single turn.
Multi-turn context management Keep context under control across a long agent run.
Search-and-replace edits Make exact-match file edits that stay reviewable.
Alert fatigue copilot Pull grounded patterns from noisy alerts, then probe, chat, and self-assess with strict JSON.

Use cases

Build end-to-end: multimodal perception, orchestration, and complete apps you can adapt.
Chart analysis Read charts and extract structured data from images.
Error screenshot fix Diagnose a bug from a screenshot and ship the fix.
Smart glasses with OpenClaw Look, ask out loud, and hear the answer — hands-free on Ray-Ban Meta glasses.
Generating slides Generate a slide deck from a prompt or source content.
Browser-verified web design Build a website with a coding agent that checks its own work in a real browser.
Iterative game dev Build a browser game end-to-end with a coding agent, verified in a real browser.
Sandboxed execution Execute model-generated code in a sandbox.
Multi-agent orchestration Orchestrate a team of specialists that coordinate through a shared Kanban board.
One-shot game dev Build a complete 3D browser game in one pass — one structured prompt, no iteration loop.
Perception grounding Pin interactive dots at object pixel locations and generate a self-contained HTML overlay.
GitHub agent Run an autonomous GitHub Actions bot for triage, PR review, and bug-fix PRs on OpenCode and Muse Spark.
Computer use Control a desktop from screenshots with a computer-use agent.
Computer use on macOS Drive a real Mac from screenshots with native mouse and keyboard events.

Building with Muse Code

Build durable, auditable agents with Muse Code — the harness building blocks for safety, recovery, and orchestration.
Audit and resume agent sessions Replay any session exactly as it ran from an append-only event log, show who authorized each action, then kill the run mid-task and resume with no duplicate side effects.
Deterministic replay in CI Turn recorded events into a golden fixture and replay its model-context projection as a merge-blocking CI check.
Staged approvals Split a compound shell command into stages so safe ones auto-resolve while risky ones hold for review.
Contained execution Run every command in an OS sandbox that refuses to proceed unless containment is proven live.
Immutable guardrails The agent can't rewrite its own rules: guardrail edits stop for review and a shell write to the same path fails read-only at the sandbox.
Subagent fanout Fan one job out to parallel subagents, each in its own isolated git worktree.
Goal tracking Pin an objective once and the harness audits the work against acceptance checks before the goal can close.
Bundled skills Drive the built-in /plan, /grilling, /grill-with-docs, and /taste skills to plan, pressure-test, and build.
Loop and cron Schedule recurring or one-time agent work in natural language, then view, change, or cancel it from the same chat.
Side chats Branch off the main thread for a side conversation that never enters the main history.
Was this page helpful?
API fundamentals
Agent patterns
Use cases
Building with Muse Code