API Documentation

ProStudio REST API · v1

Get API Key

Authentication

Every request needs an API key in the x-api-key header

x-api-key: psk_your_api_key_here

How to get an API key

  1. Go to Settings (your account menu → Settings & Keys)
  2. Scroll to Platform API Keys
  3. Click New key, give it a name, and copy it immediately

Requires a Business or Enterprise plan.

Requests without a valid key return 401 Unauthorized. Keys are hashed and never stored in plain text — copy yours when created, you cannot see it again.

Base URL

https://your-prostudio-domain.com

Replace with your actual ProStudio deployment URL.

All Endpoints

POST
/api/v1/generate

Submit an image, video, or audio generation job

GET
/api/v1/status

Poll job status by requestId and endpointId

GET
/api/v1/result

Fetch the completed output (URLs, data)

GET
/api/v1/endpoints

List all available AI models

How generation works

All generation is asynchronous. The generate endpoint returns a requestId immediately — you then poll /api/v1/status until the job completes, then call /api/v1/result to get the output URLs.

1. POST /generate
2. GET /status (poll)
3. GET /result

Typical generation times: images 5–15s, videos 60–180s, audio 5–20s.

Error codes

401Invalid or missing API key
400Missing required fields in request body
503Media generation service temporarily unavailable
500Unexpected server error — contact support