Backend API
The Sartiq Backend API is the primary interface for all application operations, including authentication, resource management, and orchestrating image generation workflows.
Overview
| Property |
Value |
| Base URL |
https://api.sartiq.com/api/v1 |
| Protocol |
HTTPS (TLS 1.2+) |
| Format |
JSON |
| Authentication |
OAuth2 Password Flow |
| OpenAPI Spec |
openapi.json |
API Resources
The API is organized around these primary resource groups:
Core Resources
| Resource |
Description |
Endpoints |
| Brands |
Customer organizations and their settings |
/brands/ |
| Products |
Catalog items to be photographed |
/products/ |
| Shootings |
Photo shoot sessions containing multiple looks |
/shootings/ |
| Shots |
Individual deliverable images |
/shots/ |
Generation Resources
| Resource |
Description |
Endpoints |
| Subjects |
AI model identities |
/subjects/ |
| Styles |
Visual aesthetic definitions |
/styles/ |
| Guidelines |
Generation instructions |
/guidelines/ |
| Generations |
Image generation tasks |
/generations/ |
| Predictions |
Generated image results |
/predictions/ |
Configuration Resources
| Resource |
Description |
Endpoints |
| Shot Types |
Image framing definitions |
/shot-types/ |
| Background Presets |
Predefined background options |
/background-presets/ |
| Resolution Presets |
Output resolution options |
/resolution-presets/ |
| Generation Models |
Available AI models |
/generation-models/ |
User & Organization
| Resource |
Description |
Endpoints |
| Users |
User accounts and profiles |
/users/ |
| Organizations |
Multi-tenant organization management |
/organizations/ |
| Subscriptions |
Plan and billing information |
/subscriptions/ |
Getting Started
1. Authenticate
curl -X POST https://api.sartiq.com/api/v1/login/access-token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "username=your@email.com&password=yourpassword"
2. Use the Token
curl https://api.sartiq.com/api/v1/brands/ \
-H "Authorization: Bearer <access_token>"
3. Explore Resources
See the Full API Reference for all available endpoints.
Documentation