> ## 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. # Render a video > Send prose, a topic, or a catalogue id; receive a narrated video. Asynchronous: answers with a jobId. Poll GET /v1/jobs/{jobId} for status and artifacts. Artifact URLs point at the origin holding the bytes, so downloads never travel through this API. ## OpenAPI ````yaml /openapi.json post /v1/video/render 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: 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: 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. - 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: 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: Channels description: The destinations content is made for. - name: Products description: What a campaign promotes. paths: /v1/video/render: post: tags: - Video summary: Render a video description: >- Send prose, a topic, or a catalogue id; receive a narrated video. Asynchronous: answers with a jobId. Poll GET /v1/jobs/{jobId} for status and artifacts. Artifact URLs point at the origin holding the bytes, so downloads never travel through this API. requestBody: required: true content: application/json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: domain: description: >- Which library the subject is read from. Optional, and not something to send when you are supplying your own text: with `story` it defaults to `stories`, the domain that renders prose. Required with `videoId`, `slug` or `topic`, because those name an entry in one particular catalogue and mean nothing without it. type: string enum: - algorithms - science - course - stories - chess - howto - ugc videoId: description: >- An entry already in this deployment's catalogue for `domain`. You do not need one to render your own writing — send `story` instead. type: string minLength: 1 maxLength: 300 slug: description: A catalogue entry by slug. See `videoId`. type: string minLength: 1 maxLength: 300 topic: description: >- A catalogue subject by name, for the domains that resolve one. See `videoId`. type: string minLength: 1 maxLength: 300 story: description: >- Your own prose, narrated and rendered as-is — an article, a lesson, a chapter. This is the whole input: the video is filed under an id generated from the text, so nothing has to exist on our side first. Up to 40,000 characters. type: string minLength: 1 maxLength: 40000 title: description: >- What to call the finished video. Derived from the text when omitted. type: string minLength: 1 maxLength: 200 aspect: description: >- `horizontal` for long-form, `vertical` for a feed. Defaults to horizontal. type: string enum: - horizontal - vertical quality: description: >- Low, medium, high or 4K. Defaults to `m`. Higher costs more wall-clock, not more credits. type: string enum: - l - m - h - k renderer: description: >- How the picture is made: `motif` for animated typography and diagrams, `images` for illustrated stills, `blender` for 3D scenes. Chosen for you when omitted. type: string enum: - motif - images - blender ttsProvider: description: >- Narration engine. Left to the deployment default when omitted. type: string minLength: 1 maxLength: 60 ttsVoice: description: A voice id understood by `ttsProvider`. type: string minLength: 1 maxLength: 200 ttsModel: description: A model id understood by `ttsProvider`. type: string minLength: 1 maxLength: 200 callbackUrl: description: >- An https URL to POST the finished job to, signed with `X-VC-Signature`. Omit it and poll GET /v1/jobs/{jobId} instead. type: string format: uri projectId: description: >- The project to file this work under. Optional: omit it and one is created for you, and its id comes back on the response — read it from there rather than assuming. Pass the same id across calls when you want the script, the render and the thumbnail to land in one container. A project this workspace does not own answers not_found; the work is never silently filed somewhere else. type: string minLength: 1 maxLength: 200 description: >- Send `story` and nothing else is required — the prose is the input, and the video is filed under an id derived from it. `videoId`, `slug` and `topic` are the other way in: they name something already in this deployment's catalogue and each needs a `domain` to be read against. Exactly one of the four. responses: '200': description: Success. content: application/json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: success: type: boolean const: true projectId: type: string description: >- The project this work was filed under. Read it from here — a call that sent no projectId had one created, and this is where its id comes back. examples: - prj_9x2a4c credits: type: number description: >- What this call actually cost, which is not always what was quoted. examples: - 300 creditBalance: description: >- Your balance after the charge. Absent when billing is disabled for the workspace. examples: - 3900 type: number jobId: type: string description: >- Poll `GET /v1/jobs/{jobId}`. When that job reports `status: "done"`, the finished file is `job.artifacts.video` — an origin URL you fetch directly, not through this API. examples: - job_4k1b7d status: type: string const: queued description: >- Acceptance, not completion. The work has not started when this returns. required: - success - projectId - credits - jobId - status 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: internal_error.' content: application/json: schema: $ref: '#/components/schemas/Error' '502': description: 'Failure. `code` is one of: upstream_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 - 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. securitySchemes: bearerAuth: type: http scheme: bearer description: A workspace API key. ````