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

Speakeasy Github API

REST APIs for managing the github integration

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

Tagged areas include GitHub. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 11 operations across 10 paths, and defines 12 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.

11 operations 10 paths 12 schemas 5 GET6 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 Github 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 11

Across 10 paths, the API surfaces 11 operations — 5 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Github 11

REST APIs for managing the github integration

GET
/v1/github/setup
getGithubSetupState 3 params → 2XX4XX
GET
/v1/github/check_access
checkGithubAccess 2 params → 2XX4XX
POST
/v1/github/link
linkGithubAccess 3 params → 2XX4XX
GET
/v1/github/publishing_prs
githubCheckPublishingPRs 3 params → 2XX4XX
GET
/v1/github/publishing_secrets
githubCheckPublishingSecrets 1 param → 2XX4XX
POST
/v1/github/publishing_secrets
githubStorePublishingSecrets body → 2XX4XX
POST
/v1/github/configure_code_samples
githubConfigureCodeSamples body → 2XX4XX
POST
/v1/github/configure_mintlify_repo
githubConfigureMintlifyRepo body → 2XX4XX
POST
/v1/github/configure_target
githubConfigureTarget body → 2XX4XX
POST
/v1/github/trigger_action
githubTriggerAction body → 2XX4XX
GET
/v1/github/action
getGitHubAction 3 params → 2XX4XX

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are GithubTriggerActionRequest (6 properties), GithubConfigureMintlifyRepoRequest (5 properties), GithubConfigureCodeSamplesRequest (3 properties), GithubPublishingPRResponse (3 properties). Each schema is shown below with its type and property counts.

GithubTriggerActionRequest
object
A request to trigger an action on a GitHub target
6 properties 3 required
Error
object
The Status type defines a logical error model
2 properties 2 required
GithubConfigureCodeSamplesResponse
object
A response to configure GitHub code samples
3 properties 2 required
GithubStorePublishingSecretsRequest
object
A request to store publishing secrets for a github target
2 properties 1 required
GithubConfigureMintlifyRepoRequest
object
A request to configure a GitHub repository for mintlify
5 properties 4 required
GithubPublishingPRResponse
object
Open generation PRs pending publishing
3 properties
GithubSetupStateResponse
object
The state of a particular SDK targets github setup
3 properties 3 required
GithubMissingPublishingSecretsResponse
object
A valid response containing MISSING publishing secret keys for a github target
1 property
GithubConfigureCodeSamplesRequest
object
A request to configure GitHub code samples
3 properties 3 required
GithubConfigureTargetRequest
object
A request to configure a GitHub target
2 properties 2 required
WorkflowDocument
object
A document referenced by a workflow
2 properties 1 required
GithubGetActionResponse
object
response to a getting the latest action run on a GitHub request
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

speakeasy-api-github-api-openapi.yml Raw ↑

Other APIs Speakeasy publishes across the network.

Speakeasy Artifacts API
Speakeasy Auth API
Speakeasy CodeSamples API
Speakeasy Events API
Speakeasy Organizations API
Speakeasy PublishingTokens API
Speakeasy Reports API
Speakeasy SchemaStore API
Speakeasy ShortURLs API
Speakeasy Subscriptions API
Speakeasy Suggest API
Speakeasy Workspaces API
Where this information came from

This is an independent, third-party profile of Speakeasy Github 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.