Introduction

Turn your data into finished video. Design a project once in the editor, expose the parts that change as template fields, then hand it to the API: send the values, get an MP4 back. One request from your app, CRM or workflow tool makes one video - a thousand requests make a thousand, each personalised, localised or generated on the fly from data you already have.

The Edit Square API is organised around REST. It has predictable, resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP verbs, response codes and authentication. If you can make an HTTP request, you can render.

Renders are the part you drive. Projects, templates, teams and users are read-only: they are authored in the editor, so the fields you fill are always the ones your designers exposed. Ready to get started? Create an API key.

Base URL

The base URL for all requests to the Edit Square API is:

https://healthy-lark-490.eu-west-1.convex.site

Every path is relative to it (e.g. POST /v1/renders) and requests must be authenticated - see the Authentication section for more details.

Endpoints

RendersCreate a render, track it, and collect the finished video.

ProjectsBrowse the projects you can render from.

TemplatesCheck which fields a project exposes for a render to set.

TeamsSee which teams your key can reach and bill renders to.

UsersLook up the people on a team, and the user your key acts as.