Documentation preview

Waypoint SDK docs.

These docs describe the public model Waypoint SDK is being built around: pipeline templates, runs, stages, artifacts, provider integrations, review gates, render jobs, and distribution packets.

1. Join the whitelist

Waypoint SDK is private while the core workflow model is refined with early teams.

2. Define a pipeline

Model the path from creative brief to final render using typed stages and dependencies.

3. Execute and review

Run the graph, inspect artifacts, approve review gates, and ship variants.

Core concepts

The objects in a Waypoint SDK workflow.

Pipeline

A reusable workflow template that defines the stages, dependencies, policies, and artifacts required to produce media.

Run

A single execution of a pipeline for a specific creative brief, campaign, client, or deliverable batch.

Artifact

Any durable output created by a stage, including scripts, image assets, audio, captions, renders, logs, and metadata.

Provider

A connected external service that can generate, transform, render, store, or publish part of the workflow.

Renderer

The video production layer that turns approved run state into frame-accurate Remotion compositions and exported media files.

Remotion rendering

Waypoint SDK uses Remotion for programmable video production rendering. A pipeline run produces composition input, and the render job converts that structured state into deterministic video outputs.

Scenes become React components
Captions align to voice timing
Assets resolve from artifact records
Variants render from one source timeline
Render logs remain attached to the run
Exports feed publish packets

Pipeline model

A default production graph

A pipeline is a typed graph. Stages can run sequentially, branch into parallel work, wait for provider responses, require approval, or merge artifacts before rendering.

Idea intake
Prompt brief
Brand rules
Script draft
Beat timing
Scene plan
Shot list
Voice direction
Voice render
Caption style
Caption timing
Asset search
Image generation
Music and SFX
Assembly
QC pass
Variant cuts
Remotion composition
Render queue
Metadata
Publish
Feedback

API model

Planned developer resources.

The API surface is shown as a preview. Final endpoints may change during private access, but the resource model is the direction of travel.

POST/v1/pipeline-runs

Create a run from a pipeline template and creative brief.

GET/v1/pipeline-runs/{id}

Read run state, active stage, artifacts, errors, and output readiness.

POST/v1/pipeline-runs/{id}/stages/{stage}/approve

Approve a review gate and allow downstream stages to continue.

GET/v1/artifacts/{id}

Retrieve metadata for a script, caption track, generated image, render, or publish packet.

POST/v1/render-jobs

Create a Remotion-backed render job from an approved pipeline run or variant.

GET/v1/render-jobs/{id}

Read render progress, frame state, output files, logs, and failure details.

POST/v1/providers

Register provider credentials or a managed integration endpoint.

Webhook events

Webhooks will let teams react to production state changes from their own tools. Typical consumers include internal dashboards, review queues, asset libraries, render monitors, and publishing systems.

pipeline_run.createdstage.startedstage.completedstage.failedartifact.createdreview.requiredrender.startedrender.completedpublish.completed

Data separation

Workspaces separate team data, provider credentials, artifacts, and production history.

Review gates

Teams can require approval before renders, publishing, or provider actions that affect final output.

Artifact records

Generated assets, logs, metadata, and render outputs are tracked as explicit production records.

Need access to the private docs?

Public docs describe the model. Private access will include account setup, provider configuration, run examples, and API keys when Waypoint SDK opens for selected teams.

Apply for whitelist