Quickstart
Make your first API call in 5 minutes
Quickstart
Get up and running with the BrightShot API in under 5 minutes.
Prerequisites
- A BrightShot account with an active subscription
- An API key from your dashboard
Step 1: Check Your Account
First, verify your API key works and check your credits:
curl https://api.bright-shot.com/api/v1/me \
-H "Authorization: Bearer YOUR_API_KEY"Step 2: Generate an Image
Let's virtually stage an empty room:
curl -X POST https://api.bright-shot.com/api/v1/enhance \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"image_url": "https://example.com/empty-room.jpg",
"mode": "staging",
"style": "modern",
"room_type": "living_room"
}'Response:
{
"success": true,
"request_id": "pred_abc123xyz",
"message": "Generation started. Poll /api/v1/prediction/pred_abc123xyz for results."
}Step 3: Poll for Results
Image generation takes 10-30 seconds. Poll the status endpoint:
curl https://api.bright-shot.com/api/v1/prediction/pred_abc123xyz \
-H "Authorization: Bearer YOUR_API_KEY"When complete:
{
"status": "succeeded",
"output": ["https://api.bright-shot.com/images/user123/result.jpg"],
"completed_at": "2024-01-15T10:30:00Z"
}Step 4: Download Your Image
The output array contains URLs to your generated images. Download them or use them directly in your application.
Next Steps
- Explore all available endpoints
- Learn about different modes (staging, restyle, empty-room, etc.)
- See code examples in different languages