Skip to Content
API ReferenceTemplatesOverview

Templates API

The Templates API manages reusable caption and layout templates. A template captures the styling and layout choices you want to reuse, so you can reference it by id when creating a project instead of re-specifying the same settings every time. Use these endpoints to list, create, fetch, update, and delete templates.

i
Server-to-server only

All /v1 requests use the base URL https://api.vdclip.com  with the Authorization: Bearer vdck_… header. The API is server-to-server only and has no CORS. Reading and listing templates requires the vdclip:templates:read scope; creating, updating, and deleting require vdclip:templates:write. A missing scope returns missing_scope.

Conventions

Successful responses return the resource directly with no wrapping envelope. Errors return { "errors": [{ "code", "description", <location>? }] }; common codes here are invalid_api_key (401), missing_scope (403), validation_error (422), not_found (404), and rate_limited (HTTP 429 with a Retry-After header).

List results page with a cursor query parameter (max 100) and return { "items": [...], "next_cursor": "<opaque>" | null }. When creating a project, pass an existing template id rather than re-sending the same caption and layout configuration.

Endpoints

📋

List templates

GET /v1/templates

ViewPage through the templates available to your account

Create a template

POST /v1/templates

ViewSave a new reusable caption or layout template
🔎

Get a template

GET /v1/templates/{template_id}

ViewFetch a single template by its id
✏️

Update a template

PATCH /v1/templates/{template_id}

ViewChange a template name or its configuration
🗑️

Delete a template

DELETE /v1/templates/{template_id}

ViewRemove a template you no longer need
Last updated on