The SDK relies on Composer to manage its dependencies.
To install the SDK and add it as a dependency to an existing composer.json file:
composer require "speakeasy-api/speakeasy-client-sdk-php"declare(strict_types=1);
require 'vendor/autoload.php';
use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;
$security = new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
);
$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
$request = new Operations\GetApisRequest();
$response = $sdk->apis->getApis(
request: $request
);
if ($response->apis !== null) {
// handle response
}Available methods
- 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.
- 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
- 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
- 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.
- 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.
- 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
- checkAccess
- checkPublishingPRs
- checkPublishingSecrets
- configureCodeSamples
- configureMintlifyRepo
- configureTarget
- getAction
- storePublishingSecrets
- triggerAction
- 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.
- 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
- 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.
- 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.
- 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.
- create - Shorten a URL.
- 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.
- 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
Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception.
By default an API error will raise a Errorors\SDKException exception, which has the following properties:
| Property | Type | Description |
|---|---|---|
$message |
string | The error message |
$statusCode |
int | The HTTP status code |
$rawResponse |
?\Psr\Http\Message\ResponseInterface | The raw HTTP response |
$body |
string | The response content |
When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the deleteApi method throws the following exceptions:
| Error Object | Status Code | Content Type |
|---|---|---|
| Errorors\Error | 4XX | application/json |
| Speakeasy\SpeakeasyClientSDK\Models\Errorors.SDKException | 4xx-5xx | / |
declare(strict_types=1);
require 'vendor/autoload.php';
use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;
$security = new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
);
$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
try {
$request = new Operations\DeleteApiRequest(
apiID: '<id>',
versionID: '<id>',
);
$response = $sdk->apis->deleteApi(
request: $request
);
if ($response->statusCode === 200) {
// handle response
}
} catch (Errorors\ErrorThrowable $e) {
// handle $e->$container data
throw $e;
} catch (Errorors\SDKException $e) {
// handle default exception
throw $e;
}You can override the default server globally by passing a server name to the server: str 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 |
The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
Speakeasy API: The Speakeasy API allows teams to manage common operations with their APIs
For more information about the API: The Speakeasy Platform Documentation
- SDK Installation
- SDK Example Usage
- Available Resources and Operations
- Error Handling
- Server Selection
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !