OpenAPI Specification

Our API is fully documented using the OpenAPI 3.0 specification. You can use it to generate client code, explore the API, or integrate with your tools.

Download

Generate Your Own SDK

You can use the OpenAPI Generator to create SDKs in any language:

# Install OpenAPI Generator
npm install -g @openapitools/openapi-generator-cli

# Generate SDK (example: Kotlin)
openapi-generator-cli generate \
  -i https://api.bright-shot.com/openapi.yaml \
  -g kotlin \
  -o ./brightshot-kotlin

Supported Generators

The OpenAPI specification is compatible with all major code generators:

• HTTP Clients: curl, HTTPie, Insomnia, Postman
• Languages: TypeScript, Python, Go, Ruby, Java, PHP, C#, Rust, Kotlin, Swift, Dart
• Frameworks: Axios, Fetch, Retrofit, OkHttp, Alamofire

Import to Tools

Postman

1. Open Postman
2. Click Import
3. Enter URL: https://api.bright-shot.com/openapi.yaml
4. Click Import

Insomnia

1. Open Insomnia
2. Go to Application → Preferences → Data
3. Click Import Data → From URL
4. Enter: https://api.bright-shot.com/openapi.yaml