Speakeasy Go SDK

The platform to build, test, document and distribute APIs to your users ❤️ Building really high quality APIs is hard. Speakeasy is a set of OpenAPI tools to make it easier.

Developer-friendly & type-safe Go SDK specifically catered to leverage the Speakeasy API.

Summary

Speakeasy API: The Subscriptions API manages subscriptions for CLI and registry events

For more information about the API: The Speakeasy Platform Documentation

Table of Contents

• SDK Installation
• SDK Example Usage
• Available Resources and Operations
• Global Parameters
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/speakeasy-api/speakeasy-client-sdk-go

SDK Example Usage

Example

package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
	"log"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithSecurity(shared.Security{
			APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.Apis.GetApis(ctx, operations.GetApisRequest{})
	if err != nil {
		log.Fatal(err)
	}
	if res.Apis != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

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

• CreateRemoteSource - Configure a new remote source
• GetBlob - Get blob for a particular digest
• GetManifest - Get manifest for a particular reference
• GetNamespaces - Each namespace contains many revisions.
• GetRevisions
• GetTags
• ListRemoteSources - Get remote sources attached to a particular namespace
• PostTags - Add tags to an existing revision
• Preflight - Get access token for communicating with OCI distribution endpoints
• SetVisibility - Set visibility of a namespace with an existing metadata entry

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
• GetSetup
• LinkGithub
• 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.

Speakeasy SDK

• GenerateCodeSamplePreview - Generate Code Sample previews from a file and configuration parameters.
• GenerateCodeSamplePreviewAsync - Initiate asynchronous Code Sample preview generation from a file and configuration parameters, receiving an async JobID response for polling.
• GetCodeSamplePreviewAsync - Poll for the result of an asynchronous Code Sample preview generation.

Subscriptions

• CreateSubscription - Create Subscription
• ListRegistrySubscriptions - List Subscriptions

Suggest

• Suggest - Generate suggestions for improving an OpenAPI document.
• SuggestItems - Generate generic suggestions for a list of items.
• 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

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.

By Default, an API error will return sdkerrors.SDKError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.

For example, the GenerateCodeSamplePreview function may return the following errors:

Error Type	Status Code	Content Type
sdkerrors.Error	4XX, 5XX	application/json

Example

package main

import (
	"context"
	"errors"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/sdkerrors"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
	"log"
	"os"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithSecurity(shared.Security{
			APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	content, fileErr := os.Open("example.file")
	if fileErr != nil {
		panic(fileErr)
	}

	ctx := context.Background()
	res, err := s.GenerateCodeSamplePreview(ctx, shared.CodeSampleSchemaInput{
		Languages: []string{
			"<value>",
			"<value>",
		},
		SchemaFile: shared.SchemaFile{
			Content:  content,
			FileName: "example.file",
		},
	})
	if err != nil {

		var e *sdkerrors.Error
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Select Server by Name

You can override the default server globally using the WithServer(server string) option 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
prod	https://api.prod.speakeasyapi.dev

Example

package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
	"log"
	"os"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithServer("prod"),
		speakeasyclientsdkgo.WithSecurity(shared.Security{
			APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	content, fileErr := os.Open("example.file")
	if fileErr != nil {
		panic(fileErr)
	}

	ctx := context.Background()
	res, err := s.GenerateCodeSamplePreview(ctx, shared.CodeSampleSchemaInput{
		Languages: []string{
			"<value>",
			"<value>",
		},
		SchemaFile: shared.SchemaFile{
			Content:  content,
			FileName: "example.file",
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TwoHundredApplicationJSONResponseStream != nil {
		// handle response
	}
}

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:

package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
	"log"
	"os"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithServerURL("https://api.prod.speakeasyapi.dev"),
		speakeasyclientsdkgo.WithSecurity(shared.Security{
			APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	content, fileErr := os.Open("example.file")
	if fileErr != nil {
		panic(fileErr)
	}

	ctx := context.Background()
	res, err := s.GenerateCodeSamplePreview(ctx, shared.CodeSampleSchemaInput{
		Languages: []string{
			"<value>",
			"<value>",
		},
		SchemaFile: shared.SchemaFile{
			Content:  content,
			FileName: "example.file",
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TwoHundredApplicationJSONResponseStream != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"
	"github.com/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

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 WithSecurity option 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:

package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
	"log"
	"os"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithSecurity(shared.Security{
			APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	content, fileErr := os.Open("example.file")
	if fileErr != nil {
		panic(fileErr)
	}

	ctx := context.Background()
	res, err := s.GenerateCodeSamplePreview(ctx, shared.CodeSampleSchemaInput{
		Languages: []string{
			"<value>",
			"<value>",
		},
		SchemaFile: shared.SchemaFile{
			Content:  content,
			FileName: "example.file",
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TwoHundredApplicationJSONResponseStream != nil {
		// handle response
	}
}

Global Parameters

A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set workspace_id to "<id>" at SDK initialization and then you do not have to pass the same value on calls to operations like GetAccessToken. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

Available Globals

The following global parameter is available.

Name	Type	Description
WorkspaceID	string	The WorkspaceID parameter.

Example

package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
	"log"
)

func main() {
	s := speakeasyclientsdkgo.New()

	ctx := context.Background()
	res, err := s.Auth.GetAccessToken(ctx, operations.GetAccessTokenRequest{
		WorkspaceID: "<value>",
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.AccessToken != nil {
		// handle response
	}
}

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 retry.Config object to the call by using the WithRetries option:

package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/retry"
	"log"
	"os"
	"pkg/models/operations"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithSecurity(shared.Security{
			APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	content, fileErr := os.Open("example.file")
	if fileErr != nil {
		panic(fileErr)
	}

	ctx := context.Background()
	res, err := s.GenerateCodeSamplePreview(ctx, shared.CodeSampleSchemaInput{
		Languages: []string{
			"<value>",
			"<value>",
		},
		SchemaFile: shared.SchemaFile{
			Content:  content,
			FileName: "example.file",
		},
	}, operations.WithRetries(
		retry.Config{
			Strategy: "backoff",
			Backoff: &retry.BackoffStrategy{
				InitialInterval: 1,
				MaxInterval:     50,
				Exponent:        1.1,
				MaxElapsedTime:  100,
			},
			RetryConnectionErrors: false,
		}))
	if err != nil {
		log.Fatal(err)
	}
	if res.TwoHundredApplicationJSONResponseStream != nil {
		// handle response
	}
}

If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:

package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/retry"
	"log"
	"os"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		speakeasyclientsdkgo.WithSecurity(shared.Security{
			APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	content, fileErr := os.Open("example.file")
	if fileErr != nil {
		panic(fileErr)
	}

	ctx := context.Background()
	res, err := s.GenerateCodeSamplePreview(ctx, shared.CodeSampleSchemaInput{
		Languages: []string{
			"<value>",
			"<value>",
		},
		SchemaFile: shared.SchemaFile{
			Content:  content,
			FileName: "example.file",
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TwoHundredApplicationJSONResponseStream != nil {
		// handle response
	}
}

SDK Generated by Speakeasy