> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sigmora.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Place B-roll

> Propose overlaying project media as B-roll or picture-in-picture at given times. Deterministic: runs the same composition capability a Sigma turn uses, in review mode, with no model. proposals[] holds zero or one signed proposal in the /v1/sigma/turns shape; send proposals[0].proposal unchanged to POST /v1/sigma/proposals/apply, and its edits[].turnId to POST /v1/sigma/revert. An empty proposals means nothing needed changing and summary says why. Free: nothing runs on an engine or a provider.



## OpenAPI

````yaml /openapi.json post /v1/sigma/edits/place-broll
openapi: 3.1.0
info:
  title: Sigmora API
  version: 1.0.0
  description: >-
    The priced, versioned public API. Every call authenticates with a workspace
    API key (`Authorization: Bearer sk_live_…`), names the project it files its
    output under, and reports what it cost. `GET /v1/capabilities` answers what
    this deployment can serve right now and at what price; anything it reports
    as unavailable answers 503 `capability_unavailable` rather than 404.
servers:
  - url: https://api.sigmora.org
security:
  - bearerAuth: []
tags:
  - name: Meta
    description: What this deployment serves, what it costs, and what you have spent.
  - name: Projects
    description: The container every capability files its output under.
  - name: Sessions
    description: Durable bindings between an external harness session and one project.
  - name: Assets
    description: 'Project media: direct-to-storage uploads, imports, ingest and transcripts.'
  - name: Jobs
    description: Where every asynchronous capability is collected, whatever produced it.
  - name: Text
    description: Scripts, research, articles, translation and question sets.
  - name: Video
    description: Narrated renders, footage edits, shorts and moment selection.
  - name: UGC
    description: >-
      Creator-led vertical videos: AI creators, their faces and voices, frames
      and clips.
  - name: Editing
    description: >-
      Sigma, the editor: conversational turns, granular transcript edits,
      approvals.
  - name: 3D
    description: Animated 3D renders from a description or a photograph.
  - name: Image
    description: Thumbnails, sized for the platform they are posted to.
  - name: Audio
    description: Generated music and audio engineering in Audiotool projects.
  - name: Publishing
    description: Connected destinations and queued posts.
  - name: Webhooks
    description: Signed, at-least-once delivery of job and publishing events.
  - name: Workflows
    description: Context snapshots, versioned recipes, costed proposals and their runs.
  - name: Agents
    description: Describe an outcome and let a bounded plan of capabilities run.
  - name: Research
    description: >-
      Observed hooks, creator outliers and production briefs from saved
      analyses.
  - name: Themes
    description: The canonical content taxonomy, and the niche profiles built on it.
  - name: Signals
    description: Evidence-backed trends and scored viral content.
  - name: Discovery
    description: Compiled watch plans, their runs, and source freshness.
  - name: Watchlist
    description: 'Accounts you watch: their usual reach and the posts that beat it.'
  - name: Performance
    description: Your own channels' videos against their usual, and fixes to live videos.
  - name: Autopilot
    description: The durable trend-to-distribution workflow and its checkpoints.
  - name: Campaigns
    description: Distribution records shared by the API, the dashboard and autopilot.
  - name: Brands
    description: >-
      Cross-platform identities with their own voice, rules and publishing
      commitments.
  - name: Products
    description: What a campaign promotes.
paths:
  /v1/sigma/edits/place-broll:
    post:
      tags:
        - Editing
      summary: Place B-roll
      description: >-
        Propose overlaying project media as B-roll or picture-in-picture at
        given times. Deterministic: runs the same composition capability a Sigma
        turn uses, in review mode, with no model. proposals[] holds zero or one
        signed proposal in the /v1/sigma/turns shape; send proposals[0].proposal
        unchanged to POST /v1/sigma/proposals/apply, and its edits[].turnId to
        POST /v1/sigma/revert. An empty proposals means nothing needed changing
        and summary says why. Free: nothing runs on an engine or a provider.
      operationId: sigma.edits.place_broll
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: string
                  minLength: 1
                  maxLength: 200
                  description: The project to edit.
                compositionId:
                  description: The composition to edit; omit for the project's current one.
                  type: string
                  minLength: 1
                  maxLength: 200
                request:
                  description: >-
                    The user's words for this edit; shown with the proposal and
                    restored if it is reverted.
                  type: string
                  maxLength: 2000
                placements:
                  minItems: 1
                  maxItems: 10
                  type: array
                  items:
                    type: object
                    properties:
                      assetId:
                        type: string
                        minLength: 1
                        maxLength: 200
                        description: A video or image already in the project.
                      startSec:
                        type: number
                        minimum: 0
                        maximum: 14400
                        description: >-
                          When the overlay appears, on the editor (output)
                          clock.
                      endSec:
                        type: number
                        minimum: 0
                        maximum: 14400
                        description: When it ends, on the editor (output) clock.
                      sourceStartSec:
                        description: Where a video starts playing, in its own seconds.
                        type: number
                        minimum: 0
                        maximum: 14400
                      fit:
                        description: >-
                          cover fills the box and crops the overflow (default);
                          contain shows the whole clip inside it.
                        type: string
                        enum:
                          - cover
                          - contain
                      volume:
                        description: The B-roll's own sound, 0-1. Omitted = muted.
                        type: number
                        minimum: 0
                        maximum: 1
                      rect:
                        description: >-
                          Box on the frame, 0..1 from the top-left. Omitted =
                          full frame.
                        type: object
                        properties:
                          x:
                            type: number
                            minimum: 0
                            maximum: 1
                            description: Left edge as a fraction of the frame's width, 0-1.
                          'y':
                            type: number
                            minimum: 0
                            maximum: 1
                            description: Top edge as a fraction of the frame's height, 0-1.
                          w:
                            type: number
                            minimum: 0.02
                            maximum: 1
                            description: Width as a fraction of the frame's width, 0.02-1.
                          h:
                            type: number
                            minimum: 0.02
                            maximum: 1
                            description: >-
                              Height as a fraction of the frame's height,
                              0.02-1.
                        required:
                          - x
                          - 'y'
                          - w
                          - h
                        additionalProperties: false
                    required:
                      - assetId
                      - startSec
                      - endSec
                    additionalProperties: false
              required:
                - projectId
                - placements
              additionalProperties: false
            example:
              projectId: prj_9x2a4c
              request: Show the app screen recording while I talk about subscriptions.
              placements:
                - assetId: cnt_b7c903
                  startSec: 14
                  endSec: 21.5
                  fit: cover
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  projectId:
                    type: string
                  compositionId:
                    type:
                      - string
                      - 'null'
                  summary:
                    type: string
                  proposals:
                    maxItems: 1
                    type: array
                    items:
                      type: object
                      properties:
                        summary:
                          type: string
                        proposal:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties: {}
                      required:
                        - summary
                        - proposal
                      additionalProperties: {}
                  details:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                required:
                  - success
                  - projectId
                  - compositionId
                  - summary
                  - proposals
                  - details
                additionalProperties: {}
        '400':
          description: 'Failure. `code` is one of: invalid_request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Failure. `code` is one of: unauthorized.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: 'Failure. `code` is one of: insufficient_credits, budget_capped.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Failure. `code` is one of: forbidden, origin_not_allowed.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: 'Failure. `code` is one of: not_found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'Failure. `code` is one of: conflict.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Failure. `code` is one of: rate_limited.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: 'Failure. `code` is one of: upstream_error, internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: >-
            Failure. `code` is one of: capability_unavailable,
            upstream_unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
        - success
        - error
        - code
      properties:
        success:
          const: false
        error:
          type: string
          description: >-
            Human-readable. Copy may change between releases — do not match on
            it.
        code:
          type: string
          enum:
            - invalid_request
            - unauthorized
            - forbidden
            - origin_not_allowed
            - not_found
            - conflict
            - payload_too_large
            - insufficient_credits
            - budget_capped
            - content_not_cleared
            - rate_limited
            - capability_unavailable
            - upstream_unavailable
            - upstream_error
            - internal_error
          description: Stable machine-readable cause. Branch on this.
        details:
          description: Optional structured context, e.g. the credits shortfall.
        requestId:
          type: string
          description: >-
            Identifies this request in our logs. Include it when you contact
            support.
        timestamp:
          type: string
          format: date-time
          description: When the failure was produced.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A workspace API key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.