plan

Start Plan

Start planning for a project.

This endpoint:

  1. If image attachments are provided, augments them with AI-generated names/descriptions
  2. If project_id is provided, saves augmented assets and scope data to the database
  3. Streams plan tokens while generating
  4. Emits completion with the full plan and augmented assets

The frontend should connect to Socket.IO and join the plan session room before calling this endpoint to receive streaming updates.

Args: prompt: User's project prompt session_id: Session ID for Socket.IO room (client-generated) style: Cinematic visual style text for planning context motion_graphics_style: Motion graphics style text for planning context project_id: Optional project ID for saving to database title: Optional project title (from scoping) aspect_ratio: Optional aspect ratio (from scoping) length: Optional length tier (1, 2, 3) voiceover: Optional voiceover flag ('true'/'false') files: Optional file attachments (images will be augmented) current_user: Authenticated user info db: Database session

Returns: PlanResponse with the plan text and augmented assets

post/api/projects/plan

Response

Successful Response

successboolean required
session_idstring required
planstring nullable
errorstring nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.