API Reference
Complete API reference for all BrightShot endpoints
API Reference
This is the complete API reference for the BrightShot API. All endpoints are available at https://api.bright-shot.com.
Base URL
https://api.bright-shot.com/api/v1Authentication
All endpoints require an API key in the Authorization header:
Authorization: Bearer bs_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxEndpoints Overview
Account
| Method | Endpoint | Description |
|---|---|---|
| GET | /me | Get account info and credits |
Image Generation
| Method | Endpoint | Description |
|---|---|---|
| POST | /enhance | Virtual staging & redesign |
| POST | /empty-room | Remove furniture |
| POST | /restyle | Change room style |
| POST | /lighting | Adjust lighting |
| POST | /window-view | Change window view |
| POST | /clear-sky | Clear up cloudy skies |
| POST | /upscale | Improve image quality |
| POST | /sketch-to-image | Convert sketch to image |
| POST | /freestyle | Generate from text prompt |
| POST | /modify | Modify with mask |
Status
| Method | Endpoint | Description |
|---|---|---|
| GET | /prediction/{id} | Check generation status |
| GET | /predictions | List recent predictions |
Response Codes
| Code | Description |
|---|---|
| 200 | Success |
| 400 | Bad request - invalid parameters |
| 401 | Unauthorized - invalid API key |
| 402 | Insufficient credits |
| 404 | Resource not found |
| 500 | Server error |
OpenAPI Specification
The full OpenAPI 3.0 specification is available at:
https://api.bright-shot.com/openapi.yamlYou can import this into tools like Postman, Insomnia, or use it to generate client SDKs.