APIs¶
API documentation for Sartiq platform services.
Platform APIs¶
Sartiq exposes two primary APIs that work together to power the image generation platform.
Backend API¶
The main REST API for application operations - authentication, resource management, and business logic.
| Property | Value |
|---|---|
| Base URL | https://api.sartiq.com/api/v1 |
| Authentication | OAuth2 Password Flow |
| Format | JSON |
Key Resources:
- Brands & Products - Catalog and product management
- Shootings & Looks - Photo shoot configuration
- Subjects & Styles - AI model and visual style definitions
- Generations - Image generation tasks and results
Compute API¶
The ML compute service API - handles inference jobs, training tasks, and workflow orchestration.
| Property | Value |
|---|---|
| Base URL | https://compute-api.sartiq.com/api/v1 |
| Authentication | Bearer Token |
| Format | JSON |
Key Resources:
- Tasks - Generation and processing tasks
- Training - Model training jobs
- Workflows - Multi-step orchestrated pipelines
- Monitoring - Queue and worker status
Third-Party Integrations¶
Sartiq integrates with external AI services for specialized capabilities.
| Integration | Purpose | Documentation |
|---|---|---|
| Anthropic | Claude API for text generation and analysis | Setup & Examples |
| Fal.ai | Serverless ML inference for image models | Setup & Examples |
| Gemini | Google AI services for multimodal tasks | Setup & Examples |
Quick Reference¶
Authentication Flow¶
sequenceDiagram
participant Client
participant Backend as Backend API
participant Compute as Compute API
Client->>Backend: POST /login/access-token
Backend-->>Client: access_token + refresh_token
Client->>Backend: Request + Bearer token
Backend-->>Client: Response
Client->>Compute: Request + Bearer token
Compute-->>Client: Response
Common Headers¶
Response Codes¶
| Code | Meaning |
|---|---|
200 |
Success |
201 |
Created |
400 |
Bad Request - Invalid parameters |
401 |
Unauthorized - Invalid or missing token |
403 |
Forbidden - Insufficient permissions |
404 |
Not Found |
422 |
Validation Error |
429 |
Rate Limited |
500 |
Server Error |