How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Speakeasy

Speakeasy CodeSamples API

REST APIs for retrieving Code Samples

Documentation Provider Profile APIs.io OpenAPI GitHub

Speakeasy CodeSamples API is one of 20 APIs that Speakeasy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CodeSamples. The published artifact set on APIs.io includes an OpenAPI specification, a getting-started guide, and API documentation.

This API exposes 4 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 0.4.0.

Requests are made against a single base URL, https://api.prod.speakeasy.com.

4 operations 4 paths 6 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.4.0
Base URL
https://api.prod.speakeasy.com
Authentication
API Key, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Speakeasy CodeSamples API declares 3 security schemes for authenticating requests. An API key is passed in the header as x-api-key (APIKey). An API key is passed in the header as x-workspace-identifier (WorkspaceIdentifier). It accepts HTTP bearer tokens (Bearer). By default, every request must be authenticated.

  • APIKey — The API Key for the workspace
  • WorkspaceIdentifier — The API Key for the workspace
  • Bearer — The Bearer token for the workspace

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

CodeSamples 4

REST APIs for retrieving Code Samples

GET
/v1/code_sample
Retrieve Usage Snippets
getCodeSamples 4 params → 2XX4XX
POST
/v1/code_sample/preview
Generate Code Sample Previews from a File and Configuration Parameters
generateCodeSamplePreview body → 2XX4XX5XX
POST
/v1/code_sample/preview/async
Initiate Asynchronous Code Sample Preview Generation from a File and Configuration Parameters, Receiving an Async JobID Response for Polling
generateCodeSamplePreviewAsync body → 2024XX5XX
GET
/v1/code_sample/preview/async/{jobID}
Poll for the Result of an Asynchronous Code Sample Preview Generation
getCodeSamplePreviewAsync 1 param → 2XX2024XX5XX

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CodeSampleSchemaInput (5 properties), UsageSnippet (5 properties), Error (2 properties), UsageSnippets (1 property). Each schema is shown below with its type and property counts.

CodeSamplesJobStatus
string
The current status of the job. Possible values are pending or running.
HttpMethod
string
UsageSnippet
object
5 properties 5 required
Error
object
The Status type defines a logical error model
2 properties 2 required
CodeSampleSchemaInput
object
5 properties 2 required
UsageSnippets
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

speakeasy-codesamples-api-openapi.yml Raw ↑

Other APIs Speakeasy publishes across the network.

Speakeasy SDK Generation
AE Profile APIs.io
Speakeasy Terraform Generation
AE Profile APIs.io
Speakeasy MCP Server Generation
AE Profile APIs.io
Speakeasy DocsMD
AE Profile APIs.io
Speakeasy Contract Testing
AE Profile APIs.io
Speakeasy React Query Hooks
AE Profile APIs.io
Speakeasy Gram
AE Profile APIs.io
Speakeasy Artifacts API
AE Profile APIs.io
Speakeasy Auth API
AE Profile APIs.io
Speakeasy Events API
AE Profile APIs.io
Speakeasy Github API
AE Profile APIs.io
Speakeasy Organizations API
AE Profile APIs.io
#CodeSamples
← Back to S APIs
API Details
ID
speakeasy:speakeasy-codesamples-api
Base URL
https://api.prod.speakeasy.com
Docs
https://www.speakeasy.com/
Provider
Speakeasy
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=speakeasy-codesamples-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/speakeasy-codesamples-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Speakeasy CodeSamples API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.