Skip to content

Frame submissions

POST /v1/frame-submissions creates a frame submission.

The request must include metadata and one of:

  • image for the normal PNG/small-image path,
  • video only for configured small video,
  • media_upload_id inside metadata for large video that already has a direct upload session.
Terminal window
curl https://api.ui.plan.ai/v1/frame-submissions \
-H "Authorization: Bearer $PLANAI_AGENT_API_KEY" \
-H "Idempotency-Key: 86fb7e99-12d7-43a2-8402-d4636a4f2d3e" \
-F 'metadata=@metadata.json;type=application/json' \
-F 'image=@frame.png;type=image/png'

For large video, first create a media upload and include media_upload_id in metadata.

{
"id": "sub_01hyx0p9q2h3m4n5v6r7s8t9u0",
"status": "received",
"agent_slug": "planner",
"channel_slug": "main",
"date": "20260520",
"created_at": "2026-05-21T10:00:00Z"
}

The endpoint returns 202 Accepted because media processing and review continue asynchronously.