API Documentation

Generate or regenerate your API key. Requires an active Pro subscription. Any previous key is invalidated.

{
  "api_key": "vp_a1b2c3d4e5f6..."
}

Get the currently authenticated user's info. Pro users also receive their API key if one has been generated.

{
  "id": "open_id_abc123",
  "display_name": "username",
  "avatar_url": "https://...",
  "tier": "pro",
  "api_key": "vp_a1b2c3d4e5f6..." // only for Pro users with a key
}

End the current session.

{ "ok": true }

Upload a video and schedule it for automatic posting to TikTok. Sends as multipart/form-data.

Example (curl):

# With relative time (30 minutes from now):
curl -X POST https://vidpipe.social/api/schedule \
  -H "Authorization: Bearer vp_your_api_key" \
  -F "video=@my-video.mp4" \
  -F "caption=Check this out" \
  -F "scheduled_at=30m"

# With exact datetime:
curl -X POST https://vidpipe.social/api/schedule \
  -H "Authorization: Bearer vp_your_api_key" \
  -F "video=@my-video.mp4" \
  -F "caption=Check this out" \
  -F "scheduled_at=2026-02-15T14:30:00"

Response:

{
  "id": "uuid-here",
  "status": "pending",
  "scheduled_at": "2026-02-15T14:30:00.000Z",
  "publish_mode": "inbox"
}

Daily limits:

List all scheduled videos for the authenticated user, ordered by creation date (newest first).

[
  {
    "id": "uuid",
    "original_name": "my-video.mp4",
    "file_size": 15728640,
    "caption": "Check this out",
    "scheduled_at": "2026-02-15T14:30:00.000Z",
    "status": "pending", // pending | uploading | completed | failed
    "error": null
  }
]

Delete a scheduled video. Only works for videos with status pending.

{ "ok": true }

Create a Stripe Checkout session to upgrade to Pro. Returns a URL to redirect the user to.

{
  "url": "https://checkout.stripe.com/..."
}

Open the Stripe Billing Portal to manage your subscription. Requires an active Stripe customer.

{
  "url": "https://billing.stripe.com/..."
}