api

speakeasy api

Access the Speakeasy API via the CLI

Details

Provides access to the Speakeasy API via the CLI. To authenticate with the Speakeasy API, you must first create an API key via https://app.speakeasyapi.dev (opens in a new tab) and then set the SPEAKEASY_API_KEY environment variable to the value of the API key.

Usage

speakeasy api [flags]

Options

  -h, --help   help for api

Parent Command

• speakeasy - The speakeasy cli tool provides access to the speakeasyapi.dev toolchain

Sub Commands

• speakeasy api download-latest-schema - Download latest schema
• speakeasy api download-schema-revision - Download schema revision
• speakeasy api find-api-endpoint - Find ApiEndpoint
• speakeasy api generate-openapi-spec - Generate OpenAPI spec
• speakeasy api generate-openapi-spec-for-api-endpoint - Generate OpenAPI spec for API endpoint
• speakeasy api generate-postman-collection - Generate Postman collection
• speakeasy api generate-postman-collection-for-api-endpoint - Generate Postman collection for API endpoint
• speakeasy api get-all-api-endpoints - Get all API endpoints
• speakeasy api get-all-api-endpoints-for-version - Get all API endpoints for version
• speakeasy api get-api-endpoint - Get ApiEndpoint
• speakeasy api get-api-versions - Get Api versions
• speakeasy api get-apis - Get all Apis
• speakeasy api get-plugins - Get plugins
• speakeasy api get-request-from-event-log - Get request from event log
• speakeasy api get-schema-diff - Get schema diff
• speakeasy api get-schema-revision - Get schema revision
• speakeasy api get-schemas - Get schemas
• speakeasy api get-valid-embed-access-tokens - Get valid embed access tokens
• speakeasy api get-version-metadata - Get version metadata
• speakeasy api query-event-log - Query event log
• speakeasy api register-schema - Register schema
• speakeasy api run-plugin - Run plugin
• speakeasy api upsert-plugin - Upsert plugin