@speakeasy-api/speakeasy-client-sdk-typescript
v4.0.0-rc.2
Published
<!-- Start Summary [summary] --> ## Summary
Downloads
94
Maintainers
Keywords
Readme
@speakeasy-api/speakeasy-client-sdk-typescript
Summary
Speakeasy API: The Speakeasy API allows teams to manage common operations with their APIs
For more information about the API: The Speakeasy Platform Documentation
Table of Contents
- SDK Installation
- Requirements
- SDK Example Usage
- Available Resources and Operations
- Standalone functions
- File uploads
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Debugging
SDK Installation
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
NPM
npm add @speakeasy-api/speakeasy-client-sdk-typescript
PNPM
pnpm add @speakeasy-api/speakeasy-client-sdk-typescript
Bun
bun add @speakeasy-api/speakeasy-client-sdk-typescript
Yarn
yarn add @speakeasy-api/speakeasy-client-sdk-typescript zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
SDK Example Usage
Example
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
const speakeasy = new Speakeasy({
security: {
apiKey: "<YOUR_API_KEY_HERE>",
},
});
async function run() {
const result = await speakeasy.apis.getApis({});
// Handle the result
console.log(result);
}
run();
Available Resources and Operations
apiEndpoints
- deleteApiEndpoint - Delete an ApiEndpoint.
- findApiEndpoint - Find an ApiEndpoint via its displayName.
- generateOpenApiSpecForApiEndpoint - Generate an OpenAPI specification for a particular ApiEndpoint.
- generatePostmanCollectionForApiEndpoint - Generate a Postman collection for a particular ApiEndpoint.
- getAllApiEndpoints - Get all Api endpoints for a particular apiID.
- getAllForVersionApiEndpoints - Get all ApiEndpoints for a particular apiID and versionID.
- getApiEndpoint - Get an ApiEndpoint.
- upsertApiEndpoint - Upsert an ApiEndpoint.
apis
- deleteApi - Delete an Api.
- generateOpenApiSpec - Generate an OpenAPI specification for a particular Api.
- generatePostmanCollection - Generate a Postman collection for a particular Api.
- getAllApiVersions - Get all Api versions for a particular ApiEndpoint.
- getApis - Get a list of Apis for a given workspace
- upsertApi - Upsert an Api
artifacts
- getBlob - Get blob for a particular digest
- getManifest - Get manifest for a particular reference
- getNamespaces - Each namespace contains many revisions.
- getRevisions
- getTags
- postTags - Add tags to an existing revision
- preflight - Get access token for communicating with OCI distribution endpoints
auth
- getAccess - Get access allowances for a particular workspace
- getAccessToken - Get or refresh an access token for the current workspace.
- getUser - Get information about the current user.
- validateApiKey - Validate the current api key.
embeds
- getEmbedAccessToken - Get an embed access token for the current workspace.
- getValidEmbedAccessTokens - Get all valid embed access tokens for the current workspace.
- revokeEmbedAccessToken - Revoke an embed access EmbedToken.
events
- getEventsByTarget - Load recent events for a particular workspace
- getTargets - Load targets for a particular workspace
- getTargetsDeprecated - Load targets for a particular workspace
- post - Post events for a specific workspace
- search - Search events for a particular workspace by any field
github
- checkAccess
- checkPublishingPRs
- checkPublishingSecrets
- configureCodeSamples
- configureMintlifyRepo
- configureTarget
- getAction
- storePublishingSecrets
- triggerAction
metadata
- deleteVersionMetadata - Delete metadata for a particular apiID and versionID.
- getVersionMetadata - Get all metadata for a particular apiID and versionID.
- insertVersionMetadata - Insert metadata for a particular apiID and versionID.
organizations
- create - Create an organization
- createFreeTrial - Create a free trial for an organization
- get - Get organization
- getAll - Get organizations for a user
- getUsage - Get billing usage summary for a particular organization
reports
- getChangesReportSignedUrl - Get the signed access url for the change reports for a particular document.
- getLintingReportSignedUrl - Get the signed access url for the linting reports for a particular document.
- uploadReport - Upload a report.
requests
- generateRequestPostmanCollection - Generate a Postman collection for a particular request.
- getRequestFromEventLog - Get information about a particular request.
- queryEventLog - Query the event log to retrieve a list of requests.
schemas
- deleteSchema - Delete a particular schema revision for an Api.
- downloadSchema - Download the latest schema for a particular apiID.
- downloadSchemaRevision - Download a particular schema revision for an Api.
- getSchema - Get information about the latest schema.
- getSchemaDiff - Get a diff of two schema revisions for an Api.
- getSchemaRevision - Get information about a particular schema revision for an Api.
- getSchemas - Get information about all schemas associated with a particular apiID.
- registerSchema - Register a schema.
shortURLs
- create - Shorten a URL.
suggest
- suggest - Generate suggestions for improving an OpenAPI document.
- suggestOpenAPI - (DEPRECATED) Generate suggestions for improving an OpenAPI document.
- suggestOpenAPIRegistry - Generate suggestions for improving an OpenAPI document stored in the registry.
workspaces
- create - Create a workspace
- createToken - Create a token for a particular workspace
- deleteToken - Delete a token for a particular workspace
- get - Get workspace by context
- getAll - Get workspaces for a user
- getByID - Get workspace
- getFeatureFlags - Get workspace feature flags
- getSettings - Get workspace settings
- getTeam - Get team members for a particular workspace
- getTokens - Get tokens for a particular workspace
- grantAccess - Grant a user access to a particular workspace
- revokeAccess - Revoke a user's access to a particular workspace
- update - Update workspace details
- updateSettings - Update workspace settings
Error Handling
All SDK methods return a response object or throw an error. By default, an API error will throw a errors.SDKError
.
If a HTTP request fails, an operation my also throw an error from the sdk/models/errors/httpclienterrors.ts
module:
| HTTP Client Error | Description | | ---------------------------------------------------- | ---------------------------------------------------- | | RequestAbortedError | HTTP request was aborted by the client | | RequestTimeoutError | HTTP request timed out due to an AbortSignal signal | | ConnectionError | HTTP client was unable to make a request to a server | | InvalidRequestError | Any input used to create a request is invalid | | UnexpectedClientError | Unrecognised or unexpected error |
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the deleteApi
method may throw the following errors:
| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4XX, 5XX | */* |
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
import { SDKValidationError } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/errors";
const speakeasy = new Speakeasy({
security: {
apiKey: "<YOUR_API_KEY_HERE>",
},
});
async function run() {
let result;
try {
result = await speakeasy.apis.deleteApi({
apiID: "<id>",
versionID: "<id>",
});
// Handle the result
console.log(result);
} catch (err) {
switch (true) {
case (err instanceof SDKValidationError): {
// Validation errors can be pretty-printed
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
default: {
throw err;
}
}
}
}
run();
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError
that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue
. Additionally, a pretty()
method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
Server Selection
Select Server by Name
You can override the default server globally by passing a server name to the server
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
| Name | Server | Variables |
| ----- | ------ | --------- |
| prod
| https://api.prod.speakeasyapi.dev
| None |
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
const speakeasy = new Speakeasy({
server: "prod",
security: {
apiKey: "<YOUR_API_KEY_HERE>",
},
});
async function run() {
const result = await speakeasy.apis.deleteApi({
apiID: "<id>",
versionID: "<id>",
});
// Handle the result
console.log(result);
}
run();
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the serverURL
optional parameter when initializing the SDK client instance. For example:
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
const speakeasy = new Speakeasy({
serverURL: "https://api.prod.speakeasyapi.dev",
security: {
apiKey: "<YOUR_API_KEY_HERE>",
},
});
async function run() {
const result = await speakeasy.apis.deleteApi({
apiID: "<id>",
versionID: "<id>",
});
// Handle the result
console.log(result);
}
run();
Custom HTTP Client
The TypeScript SDK makes API calls using an HTTPClient
that wraps the native
Fetch API. This
client is a thin wrapper around fetch
and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient
constructor takes an optional fetcher
argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest"
hook to to add a
custom header and a timeout to requests and how to use the "requestError"
hook
to log errors:
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
import { HTTPClient } from "@speakeasy-api/speakeasy-client-sdk-typescript/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new Speakeasy({ httpClient });
Authentication
Per-Client Security Schemes
This SDK supports the following security schemes globally:
| Name | Type | Scheme |
| --------------------- | --------------------- | --------------------- |
| apiKey
| apiKey | API key |
| bearer
| http | HTTP Bearer |
| workspaceIdentifier
| apiKey | API key |
You can set the security parameters through the security
optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
const speakeasy = new Speakeasy({
security: {
apiKey: "<YOUR_API_KEY_HERE>",
},
});
async function run() {
const result = await speakeasy.apis.deleteApi({
apiID: "<id>",
versionID: "<id>",
});
// Handle the result
console.log(result);
}
run();
Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
const speakeasy = new Speakeasy({
security: {
apiKey: "<YOUR_API_KEY_HERE>",
},
});
async function run() {
const result = await speakeasy.apis.deleteApi({
apiID: "<id>",
versionID: "<id>",
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
// Handle the result
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
const speakeasy = new Speakeasy({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
security: {
apiKey: "<YOUR_API_KEY_HERE>",
},
});
async function run() {
const result = await speakeasy.apis.deleteApi({
apiID: "<id>",
versionID: "<id>",
});
// Handle the result
console.log(result);
}
run();
Requirements
For supported JavaScript runtimes, please consult RUNTIMES.md.
Standalone functions
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
apiEndpointsDeleteApiEndpoint
- Delete an ApiEndpoint.apiEndpointsFindApiEndpoint
- Find an ApiEndpoint via its displayName.apiEndpointsGenerateOpenApiSpecForApiEndpoint
- Generate an OpenAPI specification for a particular ApiEndpoint.apiEndpointsGeneratePostmanCollectionForApiEndpoint
- Generate a Postman collection for a particular ApiEndpoint.apiEndpointsGetAllApiEndpoints
- Get all Api endpoints for a particular apiID.apiEndpointsGetAllForVersionApiEndpoints
- Get all ApiEndpoints for a particular apiID and versionID.apiEndpointsGetApiEndpoint
- Get an ApiEndpoint.apiEndpointsUpsertApiEndpoint
- Upsert an ApiEndpoint.apisDeleteApi
- Delete an Api.apisGenerateOpenApiSpec
- Generate an OpenAPI specification for a particular Api.apisGeneratePostmanCollection
- Generate a Postman collection for a particular Api.apisGetAllApiVersions
- Get all Api versions for a particular ApiEndpoint.apisGetApis
- Get a list of Apis for a given workspaceapisUpsertApi
- Upsert an ApiartifactsGetBlob
- Get blob for a particular digestartifactsGetManifest
- Get manifest for a particular referenceartifactsGetNamespaces
- Each namespace contains many revisions.artifactsGetRevisions
artifactsGetTags
artifactsPostTags
- Add tags to an existing revisionartifactsPreflight
- Get access token for communicating with OCI distribution endpointsauthGetAccess
- Get access allowances for a particular workspaceauthGetAccessToken
- Get or refresh an access token for the current workspace.authGetUser
- Get information about the current user.authValidateApiKey
- Validate the current api key.embedsGetEmbedAccessToken
- Get an embed access token for the current workspace.embedsGetValidEmbedAccessTokens
- Get all valid embed access tokens for the current workspace.embedsRevokeEmbedAccessToken
- Revoke an embed access EmbedToken.eventsGetEventsByTarget
- Load recent events for a particular workspaceeventsGetTargets
- Load targets for a particular workspaceeventsGetTargetsDeprecated
- Load targets for a particular workspaceeventsPost
- Post events for a specific workspaceeventsSearch
- Search events for a particular workspace by any fieldgithubCheckAccess
githubCheckPublishingPRs
githubCheckPublishingSecrets
githubConfigureCodeSamples
githubConfigureMintlifyRepo
githubConfigureTarget
githubGetAction
githubStorePublishingSecrets
githubTriggerAction
metadataDeleteVersionMetadata
- Delete metadata for a particular apiID and versionID.metadataGetVersionMetadata
- Get all metadata for a particular apiID and versionID.metadataInsertVersionMetadata
- Insert metadata for a particular apiID and versionID.organizationsCreate
- Create an organizationorganizationsCreateFreeTrial
- Create a free trial for an organizationorganizationsGet
- Get organizationorganizationsGetAll
- Get organizations for a userorganizationsGetUsage
- Get billing usage summary for a particular organizationreportsGetChangesReportSignedUrl
- Get the signed access url for the change reports for a particular document.reportsGetLintingReportSignedUrl
- Get the signed access url for the linting reports for a particular document.reportsUploadReport
- Upload a report.requestsGenerateRequestPostmanCollection
- Generate a Postman collection for a particular request.requestsGetRequestFromEventLog
- Get information about a particular request.requestsQueryEventLog
- Query the event log to retrieve a list of requests.schemasDeleteSchema
- Delete a particular schema revision for an Api.schemasDownloadSchema
- Download the latest schema for a particular apiID.schemasDownloadSchemaRevision
- Download a particular schema revision for an Api.schemasGetSchema
- Get information about the latest schema.schemasGetSchemaDiff
- Get a diff of two schema revisions for an Api.schemasGetSchemaRevision
- Get information about a particular schema revision for an Api.schemasGetSchemas
- Get information about all schemas associated with a particular apiID.schemasRegisterSchema
- Register a schema.shortURLsCreate
- Shorten a URL.suggestSuggest
- Generate suggestions for improving an OpenAPI document.suggestSuggestOpenAPI
- (DEPRECATED) Generate suggestions for improving an OpenAPI document.suggestSuggestOpenAPIRegistry
- Generate suggestions for improving an OpenAPI document stored in the registry.workspacesCreate
- Create a workspaceworkspacesCreateToken
- Create a token for a particular workspaceworkspacesDeleteToken
- Delete a token for a particular workspaceworkspacesGet
- Get workspace by contextworkspacesGetAll
- Get workspaces for a userworkspacesGetByID
- Get workspaceworkspacesGetFeatureFlags
- Get workspace feature flagsworkspacesGetSettings
- Get workspace settingsworkspacesGetTeam
- Get team members for a particular workspaceworkspacesGetTokens
- Get tokens for a particular workspaceworkspacesGrantAccess
- Grant a user access to a particular workspaceworkspacesRevokeAccess
- Revoke a user's access to a particular workspaceworkspacesUpdate
- Update workspace detailsworkspacesUpdateSettings
- Update workspace settings
File uploads
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
[!TIP]
Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
- Node.js v20+: Since v20, Node.js comes with a native
openAsBlob
function innode:fs
.- Bun: The native
Bun.file
function produces a file handle that can be used for streaming file uploads.- Browsers: All supported browsers return an instance to a
File
when reading the value from an<input type="file">
element.- Node.js v18: A file stream can be created using the
fileFrom
helper fromfetch-blob/from.js
.
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
import { openAsBlob } from "node:fs";
const speakeasy = new Speakeasy({
security: {
apiKey: "<YOUR_API_KEY_HERE>",
},
});
async function run() {
const result = await speakeasy.schemas.registerSchema({
apiID: "<id>",
versionID: "<id>",
requestBody: {
file: await openAsBlob("example.file"),
},
});
// Handle the result
console.log(result);
}
run();
Debugging
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console
's interface as an SDK option.
[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
const sdk = new Speakeasy({ debugLogger: console });