> ## 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. # Make a UGC video > Make one vertical, creator-led UGC video. Resolves an approved catalog or saved presenter, creates one durable UGC video job, and returns immediately. Poll GET /v1/jobs/{jobId}; the same idempotency key recovers a lost acknowledgement without starting a second render. Quote first with X-Sigmora-Quote-Only, then cap the real call with X-Sigmora-Max-Credits. ## OpenAPI ````yaml /openapi.json post /v1/video/ugc 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/video/ugc: post: tags: - UGC summary: Make a UGC video description: >- Make one vertical, creator-led UGC video. Resolves an approved catalog or saved presenter, creates one durable UGC video job, and returns immediately. Poll GET /v1/jobs/{jobId}; the same idempotency key recovers a lost acknowledgement without starting a second render. Quote first with X-Sigmora-Quote-Only, then cap the real call with X-Sigmora-Max-Credits. operationId: postVideoUgc parameters: - name: idempotency-key in: header required: true description: >- Required durable retry key. Reuse only for the identical logical request; a different payload returns conflict. schema: type: string minLength: 1 maxLength: 255 description: >- Required durable retry key. Reuse only for the identical logical request; a different payload returns conflict. - name: x-sigmora-quote-only in: header required: false description: Send 1 to get the price and balance without running anything. schema: description: Send 1 to get the price and balance without running anything. type: string const: '1' - name: x-sigmora-max-credits in: header required: false description: >- The approved price; a call that would cost more is refused and nothing is charged. schema: description: >- The approved price; a call that would cost more is refused and nothing is charged. type: string pattern: ^\d+$ requestBody: required: true content: application/json: schema: type: object properties: mode: default: generate description: >- Use generate for a new script-led take, talking-avatar to animate the presenter photo speaking the script (talking-head only), or source-performance to transfer a declared source video performance onto the approved presenter. A saved real person needs a verified likeness consent in every mode. type: string enum: - generate - source-performance - talking-avatar format: type: string enum: - talking-head - product-in-hands description: 'Vertical UGC format: talking-head or product-in-hands.' presenter: type: string minLength: 1 maxLength: 200 description: >- Stable presenter reference: catalog:: or saved:. productImage: type: string minLength: 1 maxLength: 2000 description: >- Public HTTPS image URL or Content Engine content id; media bytes never go through MCP. script: type: string minLength: 8 maxLength: 600 description: Approved spoken script for the single-take render. captions: default: false description: >- Opt in to burned captions in the delivered video; defaults to false. type: boolean productRights: type: boolean const: true description: >- Explicit confirmation that the caller has rights to use the product image. likenessConsent: type: boolean const: true description: >- Explicit confirmation that the presenter likeness is approved for this render. scriptClaims: type: boolean const: true description: >- Explicit confirmation that product claims in the script are accurate and approved. sourceVideo: description: >- For source-performance, choose this direct public HTTPS source-video URL or Content Engine content id, or sourceAssetId; media bytes never go through MCP. type: string minLength: 1 maxLength: 2000 sourceAssetId: description: >- For source-performance, a ready visual-video Asset in this workspace Library. Use this instead of sourceVideo when the source is already in Sigmora. type: string minLength: 1 maxLength: 200 sourceUse: description: >- Required only for source-performance: the requester-declared authority for the source video (owned, licensed, or permission). type: string enum: - owned - licensed - permission sourceWindow: description: >- Optional, source-performance only: copy just this part of the source video (3-30 seconds). Omit to let Sigmora pick from the whole video. type: object properties: startSec: type: number minimum: 0 description: >- Start of the part to copy, in seconds into the source video. endSec: type: number exclusiveMinimum: 0 description: >- End of the part to copy, in seconds into the source video. required: - startSec - endSec additionalProperties: false sourcePerformerRights: description: >- Required only for source-performance: requester attests they have the source performer’s authorization. This is not independently verified by Sigmora. type: boolean const: true sourceRightsholderRights: description: >- Required only for source-performance: requester attests they have authority from the source video’s rightsholder. This is not independently verified by Sigmora. type: boolean const: true projectId: type: string minLength: 1 maxLength: 200 description: Existing project that owns the generated UGC video. required: - format - presenter - productImage - script - productRights - likenessConsent - scriptClaims - projectId example: projectId: prj_9x2a4c format: product-in-hands presenter: catalog:maya-fitness:cafe productImage: https://cdn.example.com/products/pocketledger-phone.png script: >- I stopped guessing where my money goes. PocketLedger shows me every subscription in one screen. captions: true productRights: true likenessConsent: true scriptClaims: true responses: '202': description: Success. content: application/json: schema: type: object properties: success: type: boolean const: true projectId: type: string jobId: type: string kind: type: string const: video.render workflow: type: string const: ugc status: type: string const: rendering targetSeconds: type: integer minimum: -9007199254740991 maximum: 9007199254740991 captions: type: boolean credits: type: number reconciliationRequired: type: boolean required: - success - projectId - jobId - kind - workflow - status - targetSeconds - captions - reconciliationRequired 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' '413': description: 'Failure. `code` is one of: payload_too_large.' 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.