getziztu-com Script API

openapi: 3.2.0
info:
  title: Ziztu Script API
  version: '1'
  description: Stable public API for Ziztu. Create and manage animated film projects, drive the Director AI, generate frames and clips, manage credits, and run the studio apps (AI Animation Generator, AI Manga Maker, AI Story Video Generator, AI Explainer Video Maker, AI Comedy Skit Maker).
  contact:
    url: https://getziztu.com
    email: support@getziztu.com
servers:
- url: /api/v1
  description: Ziztu API v1
security:
- bearerToken: []
- apiKey: []
tags:
- name: Script
  description: 'AI Script Writer (text only): guided draft, editor chat, Script Doctor, versions, import and export, script to shots'
paths:
  /projects/{pid}/script:
    get:
      summary: Read the script
      operationId: readScript
      tags:
      - Script
      description: The outline of every scene and the Fountain text (all scenes, or ?scenes=1,2).
      responses:
        '200':
          description: Script view
  /script/draft:
    post:
      summary: Start or price a guided draft
      operationId: startScriptDraft
      tags:
      - Script
      description: 'Story plan, scenes, editor pass. Returns a job: poll GET /projects/{pid}/script/jobs/{jid}. Needs max_credits (dry_run: true prices it; confirm: true above 5000).'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                idea:
                  type: string
                format:
                  type: string
                  enum:
                  - short-film
                  - anime-ep
                  - ad
                  - youtube
                project_id:
                  type: string
                plan_only:
                  type: boolean
                plan_job_id:
                  type: string
                replace_existing:
                  type: boolean
                max_credits:
                  type: number
                confirm:
                  type: boolean
                dry_run:
                  type: boolean
      responses:
        '200':
          description: Quote (dry_run)
        '202':
          description: Job started
  /projects/{pid}/script/jobs/{jid}:
    get:
      summary: Get a script job
      operationId: getScriptJob
      tags:
      - Script
      description: Steps, the plan and the result. ?wait= returns early when a step finishes.
      responses:
        '200':
          description: Job view
  /projects/{pid}/script/ask:
    post:
      summary: Ask the script editor
      operationId: askScriptEditor
      tags:
      - Script
      description: Answers about the script and proposes edits with ids; nothing changes until they are applied.
      responses:
        '200':
          description: Answer and proposals, or a job
  /projects/{pid}/script/edits:
    post:
      summary: Apply or reject proposals
      operationId: decideScriptEdits
      tags:
      - Script
      responses:
        '200':
          description: One result per edit
  /projects/{pid}/script/doctor:
    post:
      summary: Run the Script Doctor
      operationId: runScriptDoctor
      tags:
      - Script
      responses:
        '200':
          description: Notes, or a job
  /projects/{pid}/script/versions:
    get:
      summary: List versions or compare
      operationId: listScriptVersions
      tags:
      - Script
      responses:
        '200':
          description: Versions, or a comparison with ?compare=
  /projects/{pid}/script/versions/{vid}/restore:
    post:
      summary: Restore a version
      operationId: restoreScriptVersion
      tags:
      - Script
      responses:
        '200':
          description: Restored
  /script/import:
    post:
      summary: Import a script
      operationId: importScript
      tags:
      - Script
      description: Fountain, Final Draft or plain text, into a project or a new one.
      responses:
        '200':
          description: Imported
  /projects/{pid}/script/export:
    post:
      summary: Export the script
      operationId: exportScript
      tags:
      - Script
      description: fountain inline; pdf or fdx as a ten-minute download link.
      responses:
        '200':
          description: Text or link
  /projects/{pid}/script/shots:
    post:
      summary: Plan shots from scenes
      operationId: scriptToShots
      tags:
      - Script
      description: A Director message of cast, place and shot proposals; add them with POST /projects/{pid}/director/messages/{mid}/apply-all.
      responses:
        '200':
          description: Shot plan, or a job
components:
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      description: 'SaaS: Authorization: Bearer sk_sakuga_... | Local: Authorization: Bearer $SAKUGA_API_TOKEN'
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key