API Reference

Integrate the iPulse AI neural rendering engines directly into your applications. Our REST API handles authentication via Bearer tokens, accepts JSON request payloads, and delivers secure storage URLs for generated assets.

Base URL: https://api.ipulselabs.net/v1

Authentication

All requests to the iPulse API must include an authorization header with your secret API key. Never expose your API keys in client-side code or public repositories.

Authorization: Bearer sk_live_ipulse_72x9d8...

POST
Text to Speech

/v1/audio/speech

Converts text inputs to lifelike speech streams. Returns the audio stream directly or delivers an R2 CDN URL.

Request Parameters
inputrequiredstring

The text content to convert to voice. Max characters: 15,000.

voice_idrequiredstring

ID of system voice (e.g. "eve") or a custom cloned voice.

stabilityfloat

Stability coefficient from 0.0 to 1.0. Default is 0.70.

curl https://api.ipulselabs.net/v1/audio/speech \
  -H "Authorization: Bearer $IPULSE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "Neural voice synthesis active.",
    "voice_id": "eve",
    "stability": 0.75
  }' --output speech.mp3

POST
Video Synthesis

/v1/video/generate

Synthesizes a new video clip from prompt variables. Runs asynchronously.

Request Parameters
promptrequiredstring

Text description of the action. Max length: 1,000 characters.

aspect_ratiostring

Target grid format (1:1, 16:9, 9:16). Default is 16:9.

durationinteger

Length in seconds (5, 10, or 15). Default is 5.

curl https://api.ipulselabs.net/v1/video/generate \
  -H "Authorization: Bearer $IPULSE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "futuristic car racing in neon cyber city, panning shot",
    "aspect_ratio": "16:9",
    "duration": 5
  }'
Response Sample (202 Accepted)
{
  "job_id": "vid_job_72x881a2d",
  "status": "queued",
  "est_rendering_time_seconds": 15
}

POST
Video Flow Extension

/v1/video/flow

Appends consecutive action scenes to an existing video source.

Request Parameters
video_urlrequiredstring

URL of source video to extend. Must resolve to an MP4 asset.

promptrequiredstring

Description of the next chronological action.

curl https://api.ipulselabs.net/v1/video/flow \
  -H "Authorization: Bearer $IPULSE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "video_url": "https://storage.ipulselabs.net/u1/source.mp4",
    "prompt": "the camera zooms in on the drivers eyes"
  }'

POST
Multi-Agent Orchestration

/v1/agent/orchestrate

Triggers the complete collaborative agent pipeline to compile a final video.

Request Parameters
briefrequiredstring

High-level concept or text description to feed the Idea Generator.

workflow_modestring

Orchestration mode (creative, research, image_to_video, verbatim).

ref_image_urlstring

Optional image link to lock character styling consistency.

curl https://api.ipulselabs.net/v1/agent/orchestrate \
  -H "Authorization: Bearer $IPULSE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "brief": "explain how quantum computing works with retro styling",
    "workflow_mode": "research",
    "duration": 30
  }'
Response Sample (202 Accepted)
{
  "crew_job_id": "crew_job_81x992",
  "status": "orchestrating",
  "active_agent": "Creative Video Idea Generator"
}