www.speakeasy.com
Open in
urlscan Pro
76.76.21.98
Public Scan
Submitted URL: https://docs.speakeasyapi.dev/
Effective URL: https://www.speakeasy.com/docs
Submission: On September 19 via automatic, source certstream-suspicious — Scanned from DE
Effective URL: https://www.speakeasy.com/docs
Submission: On September 19 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 1 forms found in the DOM
POST https://forms.hsforms.com/submissions/v3/public/submit/formsnext/multipart/21944879/2f9d352e-bcb9-4b97-8348-50e65e36d309
<form id="hsForm_2f9d352e-bcb9-4b97-8348-50e65e36d309" method="POST" accept-charset="UTF-8" enctype="multipart/form-data" novalidate=""
action="https://forms.hsforms.com/submissions/v3/public/submit/formsnext/multipart/21944879/2f9d352e-bcb9-4b97-8348-50e65e36d309"
class="hs-form-private hsForm_2f9d352e-bcb9-4b97-8348-50e65e36d309 hs-form-2f9d352e-bcb9-4b97-8348-50e65e36d309 hs-form-2f9d352e-bcb9-4b97-8348-50e65e36d309_e84f8ada-2d12-4546-8752-16167f2544e3 hs-form stacked"
target="target_iframe_2f9d352e-bcb9-4b97-8348-50e65e36d309" data-instance-id="e84f8ada-2d12-4546-8752-16167f2544e3" data-form-id="2f9d352e-bcb9-4b97-8348-50e65e36d309" data-portal-id="21944879"
data-test-id="hsForm_2f9d352e-bcb9-4b97-8348-50e65e36d309" data-hs-cf-bound="true">
<div class="hs_email hs-email hs-fieldtype-text field hs-form-field"><label id="label-email-2f9d352e-bcb9-4b97-8348-50e65e36d309" class="" placeholder="Enter your " for="email-2f9d352e-bcb9-4b97-8348-50e65e36d309"><span></span></label>
<legend class="hs-field-desc" style="display: none;"></legend>
<div class="input"><input id="email-2f9d352e-bcb9-4b97-8348-50e65e36d309" name="email" required="" placeholder="Join our newsletter*" type="email" class="hs-input" inputmode="email" autocomplete="email" value=""></div>
</div>
<div class="hs_submit hs-submit">
<div class="hs-field-desc" style="display: none;"></div>
<div class="actions"><input type="submit" class="hs-button primary large" value="Subscribe"></div>
</div><input name="hs_context" type="hidden"
value="{"embedAtTimestamp":"1726753077266","formDefinitionUpdatedAt":"1698683931004","lang":"en","embedType":"REGULAR","renderRawHtml":"true","userAgent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.36","pageTitle":"Documentation | Speakeasy","pageUrl":"https://www.speakeasy.com/docs","isHubSpotCmsGeneratedPage":false,"hutk":"3322b10a7f583c7054aca2b21f0b2188","__hsfp":90950173,"__hssc":"257349460.1.1726753076435","__hstc":"257349460.3322b10a7f583c7054aca2b21f0b2188.1726753076435.1726753076435.1726753076435.1","formTarget":"#Rjt6m","rumScriptExecuteTime":2089.9000000953674,"rumTotalRequestTime":4623.199999809265,"rumTotalRenderTime":4758.599999904633,"rumServiceResponseTime":2533.3999996185303,"rumFormRenderTime":135.40000009536743,"connectionType":"4g","firstContentfulPaint":0,"largestContentfulPaint":0,"locale":"en","timestamp":1726753079500,"originalEmbedContext":{"portalId":"21944879","formId":"2f9d352e-bcb9-4b97-8348-50e65e36d309","region":"na1","target":"#Rjt6m","isBuilder":false,"isTestPage":false,"isPreview":false,"isMobileResponsive":true},"correlationId":"e84f8ada-2d12-4546-8752-16167f2544e3","renderedFieldsIds":["email"],"captchaStatus":"NOT_APPLICABLE","emailResubscribeStatus":"NOT_APPLICABLE","isInsideCrossOriginFrame":false,"source":"forms-embed-1.5999","sourceName":"forms-embed","sourceVersion":"1.5999","sourceVersionMajor":"1","sourceVersionMinor":"5999","allPageIds":{},"_debug_embedLogLines":[{"clientTimestamp":1726753079357,"level":"INFO","message":"Retrieved pageContext values which may be overriden by the embed context: {\"pageTitle\":\"Documentation | Speakeasy\",\"pageUrl\":\"https://www.speakeasy.com/docs\",\"userAgent\":\"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.36\",\"isHubSpotCmsGeneratedPage\":false}"},{"clientTimestamp":1726753079360,"level":"INFO","message":"Retrieved countryCode property from normalized embed definition response: \"DE\""},{"clientTimestamp":1726753079369,"level":"INFO","message":"Retrieved analytics values from API response which may be overriden by the embed context: {\"hutk\":\"3322b10a7f583c7054aca2b21f0b2188\"}"}]}"><iframe
name="target_iframe_2f9d352e-bcb9-4b97-8348-50e65e36d309" style="display: none;"></iframe>
</form>Text Content
* Product
* Pricing
* Docs
* Changelog
* Showcase
* Company
* Blog
Log in
Try It Now
* Documentation
* Guides
* Examples
* OpenAPI Hub
* Home
* Start Here
* Introduction
* Why API Developer Experience?
* Concepts
* Language Maturity
* Language Design
* Our Design Philosophy
* TypeScript
* SDK Design
* Comparison to OSS Generators
* TypeScript SDK Reference
* Python
* SDK Design
* Comparison to OSS Generators
* Python SDK Reference
* Go
* SDK Design
* Comparison to OSS Generators
* Go SDK Reference
* Java
* SDK Design
* Comparison to OSS Generators
* Java SDK Reference
* C#
* SDK Design
* Comparison to OSS Generators
* PHP [Beta]
* SDK Design
* Swift [Alpha]
* SDK Design
* Ruby [Alpha]
* Coming Soon
* Unity [Beta]
* SDK Design
* Generate
* Generate SDK
* Generate Terraform Provider
* Customize
* Structure
* Imports
* Namespaces
* Data Models
* Enums
* Oneof Schemas
* Types
* Methods
* Responses & Error Handling
* Responses
* Error Handling
* Global Parameters
* Servers
* Deprecations
* Security & Authentication
* Overview
* Configuration Options
* Scope Security
* Set Environment Variables
* Basic HTTP Authentication
* API Key Authentication
* Bearer Token Authentication
* OAuth 2.0 Authentication
* Client Credentials Flow
* Custom Refresh Token Flow
* OAuth 2.0 Scopes
* Custom Security Schemes
* Security Callbacks
* SDK Behavior
* Enable Retries
* Enable Timeouts
* Enable Pagination
* Enable Streaming
* Enable server-sent events
* Customize HTTP Client
* Override Accept Headers
* Add Custom Code
* SDK Hooks
* Monkey Patching
* Terraform Provider
* Map API Entities to Terraform Resources
* Specify CRUD Operations for API Endpoints
* One API Operation, Multiple Resources
* Align API Parameter with Terraform Property
* Hide Sensitive Properties
* Exclude Property from Terraform State
* Allow JSON String Attributes
* Suppress Unnecessary Plan Changes
* Prevent Conflicting Attributes
* Configuration Validation
* Add Custom Plan Modification Logic
* Specify Resource Version
* Configuring Environment Values
* Custom Resources or Data Sources
* Modifying Resource/Data Source Descriptions
* Speciality Annotations
* Publish
* Publish Your SDK
* Setup SDK on GitHub
* Publish to Package Managers
* Publish Terraform Provider
* Advanced Set Up
* SDK Versioning
* Real Time Updates
* Setup SDK Sandbox
* Documentation
* Customize Documentation
* Integrate with Mintlify
* Integrate with other providers
* Manage APIs
* Manage Your OpenAPI
* OpenAPI Reference Guide
* OpenAPI Best Practices for SDK Generation
* OpenAPI Support Matrix
* OpenAPI Improvements
* Lint Your OpenAPI
* Create OpenAPI Overlays
* Create Overlays
* Apply Overlays
* Technical Reference
* Speakeasy Extensions
* Speakeasy CLI
* Getting Started
* Speakeasy
* Auth
* Login
* Logout
* Readme
* Switch
* Suggest
* Operation Ids
* Readme
* Generate
* Changelog
* Codesamples
* Readme
* Usage
* Version
* sdk
* Changelog
* Readme
* Version
* Merge
* API
* Proxy
* Update
* Usage
* Docs
* Overlay
* Apply
* Compare
* Readme
* Validate
* Ask
* Bump
* Clean
* Quickstart
* Run
* Status
* configure
* GitHub
* Publishing
* Readme
* Sources
* Targets
* lint
* Config
* Openapi
* Readme
* openapi
* Diff
* Lint
* Readme
* transform
* Filter Operations
* Readme
* Remove Unused
* tag
* Apply
* Promote
* Readme
* Workflow Reference
* GitHub Setup Reference
* Generation Workflow
* Generation Config Reference
* Privacy & Security
* Product Security
* Privacy Policy
* Terms of Service
* Enterprise Support
Collapse
Home
WELCOME TO SPEAKEASY DOCS
All the guides and resources you need to build great APIs with Speakeasy
QuickStart
GENERATE SDKS
Get started
Configure Github
Automate your SDK repos
Versioning
Control micro, minor and major releases
Publish Packages
Publish to your favorite package managers
Sync Docs
Add SDK code snippets to your docs
Authentication
Automate user authentication
Add Safe Custom Code
Define tailor-made API logic
Customize Methods
Group & name methods
Customize Types
Edit your data models
GENERATE TERRAFORM PROVIDERS
Get started
Resource Modeling
Define & customize your resources
Config Validation
Ensure config correctness
Plan Modification
Dynamically adjust your plans
Documentation
Customize your provider docs
TEST APIS [EARLY ACCESS]
Get started
Contract Testing
Generate comprehensive API test suites
Server Mocking
Mock your server from your OpenAPI spec
API Sequence Testing
Chain APIs into custom test suites
GOVERN APIS
Get started
Change Detection
Define & customize your resources
Linting
Enforce API standards and best practices
Support
Access expert support to optimize your experience.
CLI Reference
Skip the words and get to the nuts and bolts.
Read Docs
Community Slack
Join the Speakeasy Community Slack and talk to real people about using
Speakeasy.
Get in touch
Ask AI
Open a chat window and talk to real robots about using Speakeasy.
start conversation
Blog
About Us
We're Hiring!
Use Cases
Docs
Changelog
Community
Events
Status
Roadmap
Book a Demo
Get in touch
All systems operational
© 2024 Speakeasy, Inc. All Rights Reserved.
Terms of Service
Privacy Policy