Getting Started

The DeepManim API lets you generate educational animation videos programmatically. Create videos from text prompts, improve them iteratively, and add narration — all through a simple REST API.

Base URL: https://api.deepmanim.com/api/v1

Important Notes

Audio on generation: When you generate a new video via /generate, audio narration is included by default.
No audio on modifications: When you improve a video via /improve, the result does not include audio. Finish all your modifications first, then add audio via /audio once you are satisfied with the video.
Estimated times: Video generation takes approximately 6 minutes. The estimated_time_remaining_seconds field in the job response gives a live countdown.

Authentication

All API requests require an API key. Create one from Settings → API Keys in the app.

Requires a credit purchase. API access is available to users who have purchased credits at least once. Free-tier credits alone are not sufficient.

Include your key in the Authorization header:

Authorization: Bearer dm_k_your_api_key_here

Keep your API key secret. Do not share it in public repositories or client-side applications.

Quick Start

Generate a video in three steps: create a job, poll for completion, then retrieve the result.

1. Generate a video

curl -X POST https://api.deepmanim.com/api/v1/generate \
  -H "Authorization: Bearer dm_k_your_key" \
  -H "Content-Type: application/json" \
  -d '{"message": "Explain how photosynthesis works"}'

2. Poll for completion

curl https://api.deepmanim.com/api/v1/jobs/JOB_ID \
  -H "Authorization: Bearer dm_k_your_key"

# Response includes:
#   status: "pending" | "running" | "completed" | "failed"
#   phase: "exploring_ideas" | "brainstorming" | "crafting_vision" | "refining_details" | "assembling_pieces" | "polishing" | "adding_voice" | "iterating" | "done"
#   estimated_time_remaining_seconds: 285

3. Get the result

# When status is "completed", the response includes:
{
  "job_id": "...",
  "status": "completed",
  "phase": "done",
  "estimated_time_remaining_seconds": 0,
  "result": {
    "video_url": "https://...",
    "description": "An animation explaining photosynthesis...",
    "session_id": "...",
    "message_id": "...",
    "duration_seconds": 24.6,
    "has_audio": true,
    "follow_up": "How does cellular respiration relate to photosynthesis?"
  }
}

Endpoints

Video Generation

Jobs

Sessions

Messages

Account

Credits & Pricing

Each API call that creates a job deducts credits from your balance:

Operation	Cost
Generate video	Starts at 1.5 credits
Improve video	Starts at 1.5 credits
Add audio	1 credit
Improve narration	1 credit

Generate and improve costs depend on the selected preset and currently range from 1.5 to 70 credits. Reading sessions, messages, job status, and account info is free and does not deduct credits.

Error Responses

Status	Meaning
401	Missing or invalid API key
402	Insufficient credits
404	Resource not found (session, message, or job)
400	Invalid request (e.g. no video to improve, no narration to refine)