> ## 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. # Animate a UGC frame > Animate an approved UGC frame into a vertical clip. Prices the chosen clip model and length (quote first with X-Sigmora-Quote-Only, then cap the real call with X-Sigmora-Max-Credits), reserves at no more than that quote, and returns immediately. Poll GET /v1/jobs/{jobId}; a failed run is refunded, and the same idempotency key returns the same job at 0 credits. ## OpenAPI ````yaml /openapi.json post /v1/video/ugc/animate 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/animate: post: tags: - UGC summary: Animate a UGC frame description: >- Animate an approved UGC frame into a vertical clip. Prices the chosen clip model and length (quote first with X-Sigmora-Quote-Only, then cap the real call with X-Sigmora-Max-Credits), reserves at no more than that quote, and returns immediately. Poll GET /v1/jobs/{jobId}; a failed run is refunded, and the same idempotency key returns the same job at 0 credits. operationId: postVideoUgcAnimate 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: projectId: type: string minLength: 1 maxLength: 200 description: >- Existing project this call is made for; the clip itself is filed in the workspace Library. frameId: type: string minLength: 1 maxLength: 200 description: '`frame.id` from POST /v1/video/ugc/frame.' motion: type: string minLength: 3 maxLength: 600 description: >- What happens in the clip; a quoted line is spoken when the model makes sound. model: type: string minLength: 1 maxLength: 80 description: >- Clip model key that animates images at 9:16; an unknown key is refused. durationSec: type: integer exclusiveMinimum: 0 maximum: 60 description: >- Clip length in seconds, one the model offers. A frame of an AI creator runs as long as its dialogue. dialogue: description: >- The line an AI creator says; required when the frame shows one, ignored otherwise. type: string minLength: 1 maxLength: 400 camera: description: >- Where the phone is in an AI creator clip. Defaults to propped. type: string enum: - propped - selfie - car required: - projectId - frameId - motion - model - durationSec additionalProperties: {} example: projectId: prj_9x2a4c frameId: generated_image_5e21 motion: She tilts the phone toward the lens and taps the screen once. model: premium durationSec: 5 camera: propped responses: '200': description: Success. content: application/json: schema: type: object properties: success: type: boolean const: true quote: type: object properties: capability: type: string credits: type: number balance: type: number sufficient: type: boolean budgetCapped: type: boolean required: - capability - credits - balance - sufficient - budgetCapped additionalProperties: {} required: - success - quote additionalProperties: {} '202': description: Success. content: application/json: schema: type: object properties: success: type: boolean const: true projectId: type: string jobId: type: string credits: type: number required: - success - projectId - jobId - credits 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.