GameTorch REST API – Animations

GameTorch exposes a RESTful interface so you can programmatically create and manage animations. You will first need an API key – sign in to GameTorch, visit /account and click "Create New API Key". Send the key on each request using either the Authorization: Bearer <API_KEY> header or X-Api-Key: <API_KEY>.

Prefer using the official GameTorch CLI (under construction) for simpler scripting and downloads: https://github.com/gametorch/gametorch.

Endpoints

• POST /api/animation – start a new animation job.
  Note: input_image_base64 must be raw base64-encoded PNG bytes (no data URI prefix). duration_seconds must be exactly 5 or 10 seconds.
  Returns

  {
    "animation_id": 123
  }

• POST /api/animation/regenerate/<animation_id> – regenerate an animation with the same parameters as an existing one.
  Returns

  {
    "animation_id": 456
  }

• GET /api/animations – list your animations.
  Returns

  [\n  {\n    \"id\": 1,\n    \"status\": 1\n  }\n]

  (array)
  Note: status is numeric: 1 = generating, 2 = complete, 3 = failed & refunded.
• GET /api/animation_results/<animation_id> – list results for a single animation.
  Returns

  [\n  {\n    \"id\": 456,\n    \"fps\": 12,\n    \"status\": 1\n  }\n]

  (array)
  Note: status is numeric: 1 = generating, 2 = complete, 3 = failed & refunded.
• POST /api/animation_result – request rendering (slow/fast) of a result.
  Returns

  {
    "animation_result_id": 789,
    "duration_seconds": 5
  }

• GET /api/queue_position/<animation_result_id> – check processing queue position.
  Returns

  {
    "processing": false,
    "position": 4
  }

  or

  {
    "processing": true
  }

• GET /api/animation_result_zip/<animation_result_id> – download frames as a .zip file.
• DELETE /api/animation_result/<animation_result_id> – delete a result.
  Returns

  { "status": "ok" }

• DELETE /api/animation/<animation_id> – delete the entire animation (fails if results exist).
  Returns

  { "status": "ok" }

  or

  {
    "status": "error",
    "has_results": true
  }

• POST /api/animation_result_crop – create a cropped clip from a result.
  Returns

  { "animation_result_crop_id": 123 }

• GET /api/animation_result_crops/<animation_result_id> – list crops of a result.
  Returns

  [
    {
      "id": 1,
      "start_frame": 1,
      "end_frame": 24,
      "fps": 12,
      "crop_x": 0,
      "crop_y": 0,
      "crop_width": 512,
      "crop_height": 512,
      "label": "Hero"
    }
  ]

  (array)
• GET /api/animation_result_crop/<crop_id> – download a crop as a .zip.
• DELETE /api/animation_result_crop/<crop_id> – delete a crop.
  Returns

  { "status": "ok" }

Examples

Create an animation

curl -X POST https://gametorch.app/api/animation \
    -H "Authorization: Bearer $API_KEY" \
    -H "Content-Type: application/json" \
 -d '{
   "animation_model_id": 1,
   "prompt": "walking to the right",
   "duration_seconds": 5,
   "input_image_base64": ""
}'

Regenerate an animation

curl -X POST https://gametorch.app/api/animation/regenerate/123 \
    -H "Authorization: Bearer $API_KEY"

List your animations

curl -H "Authorization: Bearer $API_KEY" \
     "https://gametorch.app/api/animations?offset=0&limit=50"

Get results for one animation

curl -H "Authorization: Bearer $API_KEY" \
     https://gametorch.app/api/animation_results/123

Request a result render (fast mode)

curl -X POST https://gametorch.app/api/animation_result \
    -H "Authorization: Bearer $API_KEY" \
    -H "Content-Type: application/json" \
 -d '{
   "animation_id": 123,
   "fps": 12,
   "go_fast": true
}'

Check queue position

curl -H "Authorization: Bearer $API_KEY" \
     https://gametorch.app/api/queue_position/456

Download result frames as ZIP

curl -H "Authorization: Bearer $API_KEY" -o anim.zip \
     https://gametorch.app/api/animation_result_zip/456

Create a crop clip

curl -X POST https://gametorch.app/api/animation_result_crop \
    -H "Authorization: Bearer $API_KEY" \
    -H "Content-Type: application/json" \
 -d '{
   "animation_result_id": 456,
   "start_frame": 1,
   "end_frame": 24,
   "fps": 12,
   "crop_x": 0,
   "crop_y": 0,
   "crop_width": 512,
   "crop_height": 512,
   "label": "Hero entrance"
}'

Download a crop

curl -H "Authorization: Bearer $API_KEY" -o crop.zip \
     https://gametorch.app/api/animation_result_crop/789