API Documentation

Base URL: https://schemavid-api.schemavid-dev.workers.dev

Authentication

All protected endpoints require an API key passed as a Bearer token.

Authorization: Bearer sv_live_your_api_key_here

Generate your API key from the Dashboard. Keys use the sv_live_ prefix and are 48 characters total.

Rate Limits

Requests

60 per minute per API key

Processing Time

15–30 seconds per video

Credits

1 credit per video analysis

Endpoints

POST/v1/analyzeAuth

Submit a video for AI analysis. Returns a task ID immediately. Credits are deducted on submission and refunded on failure.

Request Body

{
  "video_url": "https://www.tiktok.com/@user/video/123456789"
}

Response

{
  "task_id": "sv_task_xxx",
  "status": "processing",
  "message": "Task submitted. Poll GET /v1/tasks/:id for results."
}

GET/v1/tasks/:idAuth

Poll the status and result of an analysis task. Poll every 2-3 seconds until status is completed or failed.

Response

{
  "task_id": "sv_task_xxx",
  "status": "completed",
  "result_json": {
    "video_overview": {
      "summary": "...",
      "main_theme": "...",
      "overall_vibe": "..."
    },
    "visual_flow": [
      {
        "timestamp": "00:00 - 00:02",
        "description": "..."
      }
    ],
    "audio_script": {
      "transcript": "...",
      "bgm_analysis": "..."
    },
    "strategy": {
      "hook_type": "...",
      "hook_rating_1_to_10": 9,
      "marketing_framework": "...",
      "cta_analysis": "..."
    },
    "suggested_vibe_tags": [
      "BeautyTok",
      "GRWM"
    ]
  },
  "video_url": "...",
  "created_at": "2026-01-01T00:00:00Z",
  "completed_at": "2026-01-01T00:00:28Z"
}

Error Codes

Status	Meaning
200	Success
202	Task accepted, processing
400	Invalid request (missing field, bad JSON)
401	Missing or invalid API key
402	Insufficient credits
404	Task or resource not found
429	Rate limit exceeded
500	Internal server error