API Reference
REST API for programmatic access to Brandstaq.
API Reference
Brandstaq exposes a REST API for programmatic access. Authenticate with an API key in the Authorization: Bearer header.
Base URL
https://api.brandstaq.com/api/v1/Authentication
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.brandstaq.com/api/v1/meGenerate API keys from Settings > API Keys in the dashboard.
Core Resources
Brand Kits
Create and manage brand identities. Each brand kit holds your name, colors, fonts, logo, tone, and voice preferences.
| Method | Path | Description |
|---|---|---|
| GET | /brand-kits | List your brand kits |
| POST | /brand-kits | Create a brand kit |
| GET | /brand-kits/{id} | Get brand kit details |
| PATCH | /brand-kits/{id} | Update brand kit |
| DELETE | /brand-kits/{id} | Delete brand kit |
Jobs
Create content generation jobs and track their progress.
| Method | Path | Description |
|---|---|---|
| POST | /jobs | Create a content job |
| GET | /jobs | List jobs |
| GET | /jobs/{id} | Get job status and result |
Agents
Deploy and manage autonomous agents for your brand.
| Method | Path | Description |
|---|---|---|
| GET | /brand-kits/{id}/agents | List agents for a brand |
| POST | /brand-kits/{id}/agents/deploy | Deploy a new agent |
| GET | /agents/{id} | Get agent details |
| PATCH | /agents/{id} | Update agent settings |
Chat
Send messages and manage chat sessions with your agents.
| Method | Path | Description |
|---|---|---|
| POST | /chat | Send a message |
| GET | /chat/sessions | List chat sessions |
Interactive API Docs
For the complete API reference with request/response schemas and try-it-out functionality, visit the interactive docs:
- Swagger UI: Available at
/docson your API server - ReDoc: Available at
/redocon your API server
SDKs
Coming soon. In the meantime, use the REST API directly with any HTTP client.