Getting Started

Prerequisites

• An OmnAPI account (sign up at omnapi.com).
• An API key — see Authentication.
• curl, or any HTTP client of your choice.

Your first call

1. Set your key as an env var so it doesn’t end up in shell history.

   export OMNAPI_KEY="sk_live_..."

2. Probe the gateway with a no-credit endpoint.

   curl https://api.omnapi.com/health

   You should see {"status":"ok"}.

3. Submit a real generation request. Below is a music compose call — see Quickstart for image and lyrics variants.

   curl

   curl -X POST https://api.omnapi.com/api/v1/producer/generate/music/compose \
     -H "x-api-key: $OMNAPI_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "prompt": "lofi jazz, rainy night, soft piano",
       "duration": 30
     }'

   TypeScript

   const res = await fetch(
     "https://api.omnapi.com/api/v1/producer/generate/music/compose",
     {
       method: "POST",
       headers: {
         "x-api-key": process.env.OMNAPI_KEY!,
         "Content-Type": "application/json",
       },
       body: JSON.stringify({
         prompt: "lofi jazz, rainy night, soft piano",
         duration: 30,
       }),
     },
   );
   const job = await res.json();

   Python

   import os, requests
   
   r = requests.post(
       "https://api.omnapi.com/api/v1/producer/generate/music/compose",
       headers={"x-api-key": os.environ["OMNAPI_KEY"]},
       json={"prompt": "lofi jazz, rainy night, soft piano", "duration": 30},
   )
   job = r.json()

4. Poll the job until terminal state. See Async Jobs for the full lifecycle.

Next

• Try the Interactive API Reference — paste your key and click Send.
• Read Rate Limits so you don’t surprise yourself in production.