Getting started
IntentOS Documentation
IntentOS is a social media competitor intelligence platform. This documentation covers the internal API, data models, and integration details for Pro and Enterprise users.
API access is available on the Enterprise plan. All pipeline functionality is accessible through the dashboard UI on all plans.
Authentication
All API requests require a Bearer token obtained through Supabase authentication. Include it in the Authorization header of every request.
bash
curl -X POST https://app.intentos.eu/api/pipeline/run \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"configId": "...", "maxVideos": 10, "topK": 5, "nDays": 30, "userId": "..."}'Obtain your access token by signing in through the dashboard and inspecting the session token, or via the Supabase client SDK using supabase.auth.getSession().
Endpoints
POST
/api/pipeline/runStart a pipeline run for a config. Returns a Server-Sent Events stream of progress updates.
Request body
json
{
"configId": "uuid",
"maxVideos": 20,
"topK": 5,
"nDays": 30,
"userId": "uuid"
}Response (SSE stream)
json
// SSE stream — each event is a PipelineProgress object
data: {
"status": "running",
"phase": "scraping",
"creatorsCompleted": 1,
"creatorsTotal": 4,
"videosAnalyzed": 0,
"videosTotal": 0,
"errors": [],
"log": ["Scraping @garyvee..."]
}Data Models
Config
| Field | Type | Description |
|---|---|---|
| id | uuid | Unique identifier |
| config_name | string | Display name for the pipeline configuration |
| creators_category | string | Niche or category label |
| analysis_instruction | string | Prompt sent to Gemini for video analysis |
| new_concepts_instruction | string | Prompt sent to Kimi for concept generation |
Video
| Field | Type | Description |
|---|---|---|
| id | uuid | Unique identifier |
| link | string | Original video URL |
| creator | string | Creator username (without @) |
| views | integer | View count at time of scraping |
| analysis | string | Gemini AI analysis output |
| new_concepts | string | Kimi AI generated concept brief |
| starred | boolean | User-marked as favorite |
Rate Limits
Free
20 analyses/mo
5 runs/day
Pro
500 analyses/mo
Unlimited
Enterprise
Unlimited
Unlimited
Errors
| Code | Meaning |
|---|---|
| 400 | Bad request — missing or invalid parameters |
| 401 | Unauthorized — missing or invalid access token |
| 403 | Forbidden — plan limit reached |
| 404 | Config or resource not found |
| 500 | Internal error — Apify or AI service failure |