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/run

Start 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

FieldTypeDescription
iduuidUnique identifier
config_namestringDisplay name for the pipeline configuration
creators_categorystringNiche or category label
analysis_instructionstringPrompt sent to Gemini for video analysis
new_concepts_instructionstringPrompt sent to Kimi for concept generation

Video

FieldTypeDescription
iduuidUnique identifier
linkstringOriginal video URL
creatorstringCreator username (without @)
viewsintegerView count at time of scraping
analysisstringGemini AI analysis output
new_conceptsstringKimi AI generated concept brief
starredbooleanUser-marked as favorite

Rate Limits

Free

20 analyses/mo

5 runs/day

Pro

500 analyses/mo

Unlimited

Enterprise

Unlimited

Unlimited

Errors

CodeMeaning
400Bad request — missing or invalid parameters
401Unauthorized — missing or invalid access token
403Forbidden — plan limit reached
404Config or resource not found
500Internal error — Apify or AI service failure