Speakeasy Logo

AI Control Plane
AI Control Plane
A single control plane to safely scale AI
API Platform
- Product Changelog
  What's new at Speakeasy
AI Control Plane
AI Control Plane
A single control plane to safely scale AI
API Platform
- Documentation Home
  Home for all Speakeasy product docs
- Resource Library
  Reference architecture and working definitions for the AI control plane
Use Cases
Customers
Careers
- Careers5
  Shape the future with us
Account Executive
Forward Deployed Engineer
Product Engineer
Company
- Blog
  Read our latest news and updates
Pricing

AI Control Plane API Platform

Skip to Content

CTRL K

- __INKEEP_SEARCH__
- Introduction
- Info
- Servers
  - Server Variables
- Security
  - Security Schemes in OpenAPI
    API Key
    HTTP Authentication
    Mutual TLS
    OAuth 2.0
    OpenID Connect
  - Custom Authentication
- Paths
- Operations
- Content & Media
  - File Uploads
  - Server-Sent Events
  - JSONL
- Data Types
- Requests
  - Parameters
    Path Parameters
    Query Parameters
    Header Parameters
    Cookie Parameters
- Responses
- Components
- Tags
- External Documentation
- References ($ref)
- Examples
- Extensions
- Overlays
- Webhooks
  - Callbacks
- Arazzo
- Frameworks
  - JavaScript/TypeScript
  - NestJS
  - Fastify
  - Hono
  - tRPC
  - tsoa
  - TypeSpec
  - Elysia
  - Zod
  - Python
  - FastAPI
  - Django
  - Flask
  - Pydantic
  - Go
  - Goa
  - gRPC-Gateway
  - Gnostic
  - Java
  - Spring Boot
  - PHP
  - Laravel
  - Ruby
  - Ruby on Rails
  - How To Generate an OpenAPI Document With Zod v3
- Pagination
- Guides
  - Solving Equivalent Path Signatures
  - What is the code samples extension?
- Release Notes
- OpenAPI Release Notes
- __INKEEP_SEARCH__
- Introduction
- API Design Basics
- Picking an architecture
- Structuring URLs
- HTTP Methods
- Request parameters
- Data Formats
- Request Body
- Status Codes
- Response Body
- Advanced Considerations
- File uploads
- Pagination
- Filtering responses
- Caching
- Returning Errors
- Rate limiting
- Versioning
- Productizing APIs
- Expose APIs publicly
- Monetizing APIs
- Developer experience
- Documentation
- Enforcing consistency
- Security
- API Compliance
- Testing
- Collections
- __INKEEP_SEARCH__
- MCP Hub
- Intro to MCP
- An overview of MCP
- Core Concepts
  - Tools
  - Resources
  - Transports
  - Prompts
  - Completables
  - Roots
  - Sampling
  - What are MCP apps?
- MCP for Skeptics
  - Common Criticisms Addressed
  - When to Use MCP
- The OpenAI ecosystem
- Building MCP servers
- Design MCP tools
- Deploying your MCP server
- Secure your MCP server
  - State of OAuth in MCP
  - Authorizing MCP servers
- Distribute your MCP server
- Monitor your MCP server
- - Building an MCP server for FastAPI
- Using MCP servers
- Release Notes
- MCP Release Notes
- Blog | Speakeasy
- Comparing Progressive Discovery and Semantic Search for Powering Dynamic MCP
- 5 potential use cases for Arazzo
- A Copilot for your API spec and Pagination
- A Dev Portal on Demand
- A MonoRepo For Your SDKs
- Add prompts to your MCP server
- Designing agent experience: A practical guide for the era of AX
- AI transformation is the new digital transformation. Your vendor stack isn't ready.
- Choosing an agent framework: LangChain vs LangGraph vs CrewAI vs PydanticAI vs Mastra vs Vercel AI SDK
- Security first, capability second: Building virtual employees enterprises can actually trust
- AI gateway vs MCP gateway vs AI control plane
- Announcing: EasySDK Generator
- Guide to API Auth & A Novel Approach
- API Change Detection & Open Enums
- Designing your API: Find the RESTful sweet spot
- API Experts - APIs That Build APIs
- API Experts - APIs to Fight Fraud
- API Experts - APIs that Move Money
- API Experts - APIs to Support your Customers
- API Key Management
- The Speakeasy API Landscape
- API Linting & Postman Generation
- API Ops - The Difficulties In Monitoring API Usage
- API Experts - Shipping APIs for Global Shipping
- APIs vs. SDKs: Key Differences, Use Cases, and Best Practices
- How to Handle Auth for Embedded React Components
- Automate your OAuth flows and streamline publishing
- Automated Code Samples & Overlay Management in Speakeasy Studio!
- Building a Model Context Protocol (MCP) server for Discord
- Build Custom Workflows - Sneak Peak!
- Building a SaaS API? Don't Forget Your Terraform Provider
- Building APIs (and SDKs) that never break
- How to Build an SDK in PHP
- Under the Hood: Building a High-Performance OpenAPI Parser in Go
- C# General Availability & our AI-enhanced CLI
- Choosing a docs vendor: Mintlify vs Scalar vs Bump vs ReadMe vs Redocly
- Choosing an MCP gateway: Gram vs Composio vs Arcade vs Docker vs TrueFoundry
- Choosing an SDK vendor: Speakeasy vs Fern vs Stainless vs openapi-codegen
- Choosing your Python REST API framework
- Speakeasy vs. Stainless vs. Postman: MCP server generation showdown
- Choosing an SDK generator: Speakeasy vs Stainless vs Fern vs APIMatic vs OpenAPI Generator
- Contract testing with OpenAPI
- Choosing an AI chat builder kit: CopilotKit vs OpenAI ChatKit vs Gram Elements
- How to factor cost into agentic tool design
- How To Create a Terraform Provider — a Guide for Absolute Beginners
- Custom code regions & an Overlay playground!
- Custom type support in Terraform
- Customisable Imports, OpenAPI Overlays, and Terraform generation improvements!
- Definitive Guide to API DevEx Portals
- Designing REST APIs: Responses Your Users Expect
- DevEx portals as a service
- Dynamic Dev Portals with Speakeasy Components
- End-to-end API testing with Arazzo, TypeScript, and Deno
- Early Access for Universal Typescript SDK and SDK Docs
- Easy Validation For OpenAPI
- EasyTemplate OSS Release: Templating Superpowers for Go
- Enforcing API consistency
- Making your CLI agent-friendly
- Every MCP server needs an install page
- Faster / Better speakeasy run CLI commands
- Forward compatible SDKs: strict in development, lax in production
- Speakeasy's $15M Series A
- Generate MCP servers from OpenAPI documents
- Generating MCP servers from OpenAPI: Lessons from building 50+ production MCP servers
- In Depth: Gram vs FastMCP
- Game Dev & The Rise of Developer Experience
- A New Approach to Hiring A Founding Team
- How to Build SDKs for Your API: Handwritten, OpenAPI Generator, or Speakeasy?
- How to Generate Terraform Providers
- How To Build A Best In Class Python SDK
- How to generate a mock server to test SDKs
- OpenAPI Tips - How to set operationId
- Why and How we invested in building a best in class CLI
- How We Built It - Universal Typescript
- Reducing MCP token usage by 100x — you don't need code mode
- Improved DevEX with Flattened SDKs
- Integrate with Your Favorite Docs Provider!
- Building SDKs for internal APIs: How to Boost developer velocity
- Speakeasy's $11M Raise
- Making sense of the AI control plane
- Introducing Universal TypeScript: A TS SDK your users will love
- Java General Availability and managed OAuth support
- Open Enums in Java: Why Classes Beat Native Enums for API Evolution
- Java SDKs & Telemetry
- Java Unions with Jackson: Discriminated, Non-Discriminated, and Primitives
- Label-Based Versioning, OpenAPI Transformations, and Overlay Insights
- Building an AI agent with OpenAPI: LangChain vs. Haystack
- Last changelog of the year, looking ahead, and a thank you!
- Launch week 0 round up: webhooks, react query support & more!
- Lean TypeScript SDKs for the browser
- Using Loom for Remote Collaboration
- Preparing your repo for AI development: Lessons from Gram
- MCP vs CLI: a framework for choosing the right tool interface for AI
- Mintlify Integration, Plan Validators, and Python Async Beta
- More APIs, Less Complexity
- Nivo vs Recharts - Which should you use?
- Securing Your NPM Publishing: Transitioning to Trusted Publishing
- The NSA's MCP security baseline: what it means for your gateway
- On Demand Publishing & Pre-Releases
- One-click Request Sharing
- Evolving enums for evolving APIs
- $40,000 for OSS maintainers
- Designing Forward-Compatible Unions in TypeScript SDKs
- Speakeasy OpenAPI Editor vs Swagger Editor vs Postman
- OpenAPI has flaws, so what?
- Everything You Need to Know About OpenAPI
- Defining OpenAPI Servers - The Where To Your API's How
- OpenAPI Spec Drift Detection
- OpenAPI Studio, Laravel Integration, and 'what in Zod's name?'
- OpenAPI Tips - How to Handle Auth
- OpenAPI tips - Data types and formats
- OneOf, AllOf, AnyOf Oh my! How to define union types in OpenAPI
- OpenAPI Tips - Query Parameters & Serialization
- Webhooks & Callbacks in OpenAPI/Swagger
- OpenAPI Webhook Support
- Our Series A fundraise
- The OWASP Agentic Top 10, explained
- Pact vs OpenAPI: Choosing the right foundation for your API testing strategy
- PHP Beta & SSO for Enterprises
- PHP General Availability, improved FastAPI Support, and a new billing page experience
- PHP SDKs Now Available!
- Choosing the right JavaScript API framework
- Why less is more: The Playwright proliferation problem with MCP
- Preparing your website for LLMs.
- Prompting agents: What works and why
- How To Wrap Your Terraform Provider for Pulumi
- Type Safety in Python: Pydantic vs. Data Classes vs. Annotations vs. TypedDicts
- Secure your Python SDK publishing with PyPI trusted publishing
- Python Alpha Release: Pydantic & Async
- Python HTTP Clients: Requests vs. HTTPX vs. AIOHTTP
- Python SDK Lazy Loading: 7.5x Faster Initialization, 80% Less Memory Use
- MCP vs RAG
- React Embeds
- Rebranding Speakeasy
- Agent skills for OpenAPI and SDK generation
- Persistent edits: Add custom code anywhere in your generated SDKs
- Introducing CLI generation: the agent interface your API is missing
- Introducing: API contract test generation
- Custom code regions: SDK customization without limits
- Introducing Gram: Build MCP servers that perform
- Gram Functions: A TypeScript-native framework for building agent tools
- Private server OAuth on Gram: Safe and simple MCP access for your team
- OSS Release: Granary
- Java async support: Native non-blocking SDKs with reactive streaming
- Generally Available: Java
- Native JSONL support in your SDKs
- MCP authorization: Roll out AI to every team, safely
- Managed Hosting for Generated MCP Servers
- Model Context Protocol: TypeScript SDKs for the Agentic AI ecosystem
- OSS Release: Arazzo Parser
- OSS Release: OpenAPI Parser
- Type-Safe PHP Generation
- PHP is now generally available
- Alpha Release: Postman Generator
- Python Generation with Async & Pydantic Support
- Cleaner async Python SDKs with constructor-based approach
- React Hooks: TypeScript SDKs with TanStack React Query Support
- Code as Docs Integration: SDKs embedded in your API reference
- SDK Hooks: Safely add custom logic to your SDKs
- Detailed commit messages, PR messages & release notes for SDKs
- Speakeasy Ruby SDKs now support Ruby 4.0
- One-Click SDK Testing & Experimentation with SDK Sandboxes
- Introducing comprehensive SDK Testing
- Speakeasy Docs: the documentation your API deserves
- Announcing the Speakeasy MCP Gateway: one entry point between every AI agent and every MCP server
- Introducing Speakeasy Suggest - Automatic OpenAPI Spec Maintenance
- Enhanced Server-Sent Events support
- Self-hostable MCP servers — generate with the Speakeasy CLI
- Terraform provider generation now supports ephemeral resources and actions
- Terraform provider generation feature bonanza
- Migrate any Terraform provider with data transformations
- Per-resource security and server URLs in Terraform providers
- Automatic polling support for Terraform providers
- Release: Terraform v2
- Python SDKs now use UV for 10x faster package management
- Speakeasy SDK generation now supports webhooks
- TypeScript SDKs now with Zod v4 Mini
- Replay Requests
- Request // Response: AI's Impact on API Integration Patterns and Building Frictionless Developer Experiences
- Request // Response Episode 1: Separating Deployment from Release
- Request // Response Episode 3: Anthropic MCP, GraphQL vs REST, and LLM API strategies
- Request // Response Episode 2: coding on airplanes, and the true signal of good DevEx
- Request // Response Episode 4: API Security, LLMs, and Internal Developer Tools
- The Rise of Developer Infrastructure
- Rss.xml
- Ruby SDK generation is now generally available
- Open enums and smart unions in Ruby SDKs
- Ruby SDK Generation in Beta
- Rust, AWS & API Usage Visualization
- SASS vs CSS Modules vs CSS-in-JS: How to Choose?
- SDK and Terraform Generation Improvements
- SDK Best Practices
- SDK Docs in Beta & a 2024 Sneak Peek
- SDK hooks, OpenAPI Reference & more!
- SDKs and Our March of Progress
- Seamlessly Managed SDK Versions
- Self-Serve SDK Creation Pipeline [Alpha]
- Sensitive Data Masking
- Ship types, not docs
- Skills vs MCP, a false dichotomy
- Speakeasy is SOC 2 Type II and ISO 27001 certified
- Speakeasy Branding Process: How We Decided on Look, Feel, Logo, & a Mascot
- Speakeasy is now officially SOC 2 compliant
- In Depth: Speakeasy vs APIMatic
- In depth: Speakeasy vs Fern
- In depth: Speakeasy vs liblab
- Speakeasy vs OpenAPI/Swagger Generator
- In Depth: Speakeasy vs Stainless
- Lean SDKs with Standalone Functions
- Streamlined SDK Testing & AI-Ready APIs with MCP Server Generation
- Tags Best Practices in OpenAPI
- Enhancing Terraform Providers with Configuration Validation
- Terraform Generation Alpha
- Terraform Provider Generation: 22% Faster, 32% Less Memory
- Terraform v2 & CLI Upgrade
- Test Suite Generation Early Access
- The REST Template Project
- Type Faith vs Type Safe
- Upgrade guide: TypeScript forward compatibility and fault tolerance
- UI Enhancements & deepObject Query Support for Terraform
- Unity and C# now available as generation targets!
- MCP: An in-depth introduction
- Vitest vs Jest
- We were wrong about the hard problem
- The double standard of webhook security and API security
- What is an MCP gateway and do I need one?
- Where Claude falls short in AI security
- API Experts - Why an API Platform is important
- Why API Producers Should Care About JSONL
- Why We Built Our Own OpenAPI Linter (And How It Compares)
- Why work on API developer experience?
- Why we list Zod as a dependency and not as a peer dependency
- Windows Support, Quickstart, and a V1 Sunset
- Writing Zod code that minifies
- Enterprise support

CTRL K

- Introduction
- API Design Basics
- Picking an architecture
- Structuring URLs
- HTTP Methods
- Request parameters
- Data Formats
- Request Body
- Status Codes
- Response Body
- Advanced Considerations
- File uploads
- Pagination
- Filtering responses
- Caching
- Returning Errors
- Rate limiting
- Versioning
- Productizing APIs
- Expose APIs publicly
- Monetizing APIs
- Developer experience
- Documentation
- Enforcing consistency
- Security
- API Compliance
- Testing
- Collections
- MCP Hub
- Intro to MCP
- An overview of MCP
- Core Concepts
- MCP for Skeptics
  - Common Criticisms Addressed
  - When to Use MCP
- The OpenAI ecosystem
- Building MCP servers
- Design MCP tools
- Deploying your MCP server
- Secure your MCP server
  - State of OAuth in MCP
  - Authorizing MCP servers
- Distribute your MCP server
- Monitor your MCP server
- - Building an MCP server for FastAPI
- Using MCP servers
- Release Notes
- MCP Release Notes
- Enterprise support

Docs

MCP Platform

API platform MCP Platform

Docs home
Why MCP platform

SDKs
Introduction
Core Concepts
Generate SDKs
Prepare OpenAPI Spec
Publish SDK
Guides
- Overlays
  - Creating Internal and External SDKs
  - Common JSON Path expressions
  - Common Overlays for SDKs
- Hooks
  - Authentication hook for local environment variables
  - Add telemetry to your SDK with SDK hooks and Posthog
  - Capture errors with SDK hooks and Sentry
  - Setting user agents in browser environments
- Populate Code Samples Without GitHub Actions
- SDK preview and breaking change detection
- Create a monorepo
- Generate SDK in a subdirectory
- Overriding Compile Commands for SDK Generation
- Switching default package manager to pnpm
- Manage OpenAPI specs with Speakeasy
- Tips for Integrating a TypeScript SDK into a Monorepo
- Utilizing user agent strings for telemetry
Terraform
Generate Terraform Provider
Publish Terraform Provider
Guides
- Async resource provisioning with polling
- CRUD Example
- Hoisting
- Creating a Merged Terraform entity
- Removing non-Terraform endpoints from your OpenAPI document
CLI Generation
Generate CLI
Customize CLI
Distribute CLI
CLI
- CLI
  - Getting Started
  - Using with Docker
  - Using with mise toolkit
  - agent
    context
    feedback
    setup-skills
  - ask
  - auth
    login
    logout
    status
    switch
  - billing
    activate
  - bump
  - clean
  - configure
    generation
    check
    github
    local-workflow
    publishing
    sources
    targets
    tests
  - diff
    files
    from-pr
    registry
  - lint
    arazzo
    config
    openapi
  - MCP
    deploy
  - merge
  - openapi
    diff
    lint
    snip
    transform
    cleanup
    convert-swagger
    filter-operations
    format
    normalize
    remove-unused
  - overlay
    apply
    compare
    validate
  - patches
    restore-pristine
    all
    file
    view-diff
    file
    files
    view-pristine
  - pull
  - quickstart
  - repro
  - run
  - status
  - suggest
    error-types
    operation-ids
  - tag
    apply
    promote
  - test
  - update
- - Config File
  - CI/CD Pipeline
  - TypeScript Configuration
  - Python Configuration
  - Go Configuration
  - Java Configuration
  - C# Configuration
  - PHP Configuration
  - Ruby Configuration
  - Terraform Configuration
  - MCP Server Configuration
  - CLI Configuration
- - OpenAPI Support Matrix
  - Speakeasy Terraform provider support matrix
- Extensions
- Workflow File
- Skills for AI Coding Assistants
Standalone MCP
Introduction
Generate MCP Servers from OpenAPI Documents
Deploy to Cloudflare Workers
Deploy to Gram
Custom Prompts
Custom Resources
Customize Tools
Adapting Speakeasy MCP Servers for Remote Deployment
Test with the Eval Command
Add OAuth to an MCP Server
Getting started
- Use TypeScript (Gram Functions)
- Use an OpenAPI spec
Build
Creating TypeScript tools
- Curate a custom toolset
- Create a default toolset
- Advanced tool curation
- Configure environments
- Attach environments to tool sources
- Test toolsets
- Dynamic toolsets (experimental)
- Response filtering (experimental)
- - ChatGPT Developer mode
  - Claude Code
  - Claude Desktop
  - Cline
  - Cursor
  - Gemini CLI
  - Mistral
  - n8n
  - Roo Code
  - Vellum Agents
  - IDE
  - Zapier
  - Troubleshooting
- - Anthropic API
  - OpenAI Responses API
  - Vercel AI SDK
- Export server configuration
- MCP Installation Guides
Examples
- Add AI chat to an existing app
- Build MCP with external OAuth
- Deploy from GitHub Actions
- Create a Taskmaster MCP server
- Connect to external APIs
- Build a ChatGPT App
- Using environments with the Vercel AI SDK
Catalog
Catalog overview
Sub catalogs
Secure
Security overview
Add OAuth to MCP servers
Add OAuth to Gram Functions
OAuth proxy for internal servers
Control server visibility
API keys
Environments
Observe
- Gram Agents API overview
- Billing and usage
- Usage examples
Technical Reference
CLI reference
Elements
Introduction
Quickstart
Plugins
API Reference

Changelog
Slack Community

MCP Platform DocumentationAPI Reference Type Aliases VARIANTS

Type Alias: VARIANTS

VARIANTS = readonly ["widget", "sidecar", "standalone"]

Last updated on May 6, 2026

Speakeasy Logo

Follow us on:

Twitter LinkedIn GitHub Slack

All Systems Normal

Products

AI Control Plane Generate SDKs Generate Terraform Providers Generate CLIs Generate MCP Servers Docs MCP

Resources

Resource Library Docs AI Control Plane Guide MCP Hub Changelog Enterprise API Design Guide OpenAPI Hub Our Blog

Company

About Speakeasy Customers Contact Us Book A Demo We Are Hiring Roadmap Trust Center

Legal

Privacy Policy Terms of Service Security Vulnerability Disclosure

All Systems Normal

Copyright © 2026.

Speakeasy. All rights reserved.

Build Catalog Secure Observe Technical Reference Elements