Authentication
Authenticate by passing your API key in the X-API-Key header with every request.
Quick start
- Go to Settings → Developer and create an API key.
- Copy the key (it is only shown once).
- Add
X-API-Key: sk_live_... to your requests.
curl -H "X-API-Key: sk_live_your_key_here" \
-H "Accept: application/json" \
https://mstudio.ai/api/v1/projects
const response = await fetch("https://mstudio.ai/api/v1/projects", {
headers: {
"X-API-Key": "sk_live_your_key_here",
"Accept": "application/json",
},
});
const { data } = await response.json();
console.log(data); // your projects
Scopes
Each API key can be restricted to specific scopes. Use * for full access.
| Scope | Access |
|---|
projects | Projects CRUD, script generation, sharing |
frames | Frames CRUD, versions, comments, reviews, generation job polling |
image_generation | AI image generation, editing, multi-shot |
video_generation | AI video generation, extend, lip-sync |
audio | Audio tracks CRUD, voice / SFX generation |
export | Project exports, Remotion video rendering |
teams | Team CRUD, invites, members |
assets | Asset uploads, library management |
voices | Voice library management |
Rate Limits
Requests are rate-limited per API key or per user (for Bearer token auth).
60 requests / minute per key
120 requests / minute per user
When rate limited you'll receive a 429 response. Wait and retry with exponential backoff.
Projects
Create and manage storyboard projects.
Frames
Manage frames (shots) within a project. Each frame has a script, image, and optional video.
Image Generation
Generate AI images for frames. Requires an active subscription or wallet balance.
Video Generation
Generate AI videos from frame images. Videos are generated asynchronously — poll the generation job for status.
Generation Jobs
Poll the status of async AI generation jobs (image, video, voice, SFX).
Audio
Manage audio tracks (voiceover, music, SFX) on a project timeline. AI voice and SFX generation require paid access.
Assets
Upload and manage project assets (images, audio, video files).
Export
Export storyboard projects as video files. Requires paid access.
Teams
Create teams and manage members for collaboration.
Voices
Manage your voice library for AI voiceover generation.
Error Codes
All responses use standard HTTP status codes. Error responses include a JSON body with success: false and a human-readable message.
| Code | Status | Description |
|---|
200 | OK | Request succeeded. |
201 | Created | Resource created successfully. |
401 | Unauthorized | Missing or invalid API key / token. |
402 | Payment Required | Subscription or wallet balance needed. |
403 | Forbidden | Missing required scope or endpoint not available via API key. |
404 | Not Found | Resource does not exist. |
422 | Validation Error | Request body failed validation. |
429 | Rate Limited | Too many requests. Wait and retry. |
Error response format
{
"success": false,
"message": "API key missing required scope: video_generation"
}