---
title: "Zvid API"
canonical_url: https://docs.zvid.io/docs/endpoints/zvid-api/
source: docs/endpoints/zvid-api.info.mdx
content_revision: 6338386a1dd87e4a
---

# Zvid API

Create videos and still images, manage reusable templates and editor projects, and automate render delivery. REST base URL: https://api.zvid.io. Use x-api-key for server-side integrations. Read the schema and run POST /api/render/validate/api-key before rendering: validation is free and returns creditsRequired. A queued render reserves credits and completes asynchronously. Video pricing is ceil(duration seconds) up to 1920×1080 total pixels, or ceil(duration × 4) above that; images cost 1 credit each. Plan-specific limits are enforced by authenticated validation. Browser-safe setup, errors and full workflows: https://docs.zvid.io/docs/quick-start/.

## API server

`https://api.zvid.io`

Endpoint pages show the full path, including `/api`. Create API keys at [app.zvid.io/api-keys](https://app.zvid.io/api-keys). Each operation lists the authentication it accepts.

## Choose your next step

- [Render your first video](https://docs.zvid.io/docs/quick-start/)
- [Render a still image](https://docs.zvid.io/docs/rendering-images/)
- [Understand project JSON](https://docs.zvid.io/docs/structure/)
- [Read the OpenAPI specification](https://docs.zvid.io/openapi.yaml)
- [Use documentation with an AI assistant](https://docs.zvid.io/docs/documentation-resources/)

## Operations

- [Get user profile](https://docs.zvid.io/docs/endpoints/get-user-profile/): `GET /api/user/profile`
- [Get credit balance](https://docs.zvid.io/docs/endpoints/get-credit-balance/): `GET /api/credits/balance`
- [Get transaction history](https://docs.zvid.io/docs/endpoints/get-transactions/): `GET /api/credits/transactions`
- [Get usage statistics](https://docs.zvid.io/docs/endpoints/get-usage-stats/): `GET /api/credits/usage-stats`
- [List API keys](https://docs.zvid.io/docs/endpoints/list-api-keys/): `GET /api/api-keys`
- [Create API key](https://docs.zvid.io/docs/endpoints/create-api-key/): `POST /api/api-keys`
- [Update API key](https://docs.zvid.io/docs/endpoints/update-api-key/): `PUT /api/api-keys/{id}`
- [Revoke API key](https://docs.zvid.io/docs/endpoints/revoke-api-key/): `DELETE /api/api-keys/{id}`
- [Get API key statistics](https://docs.zvid.io/docs/endpoints/get-api-key-stats/): `GET /api/api-keys/{id}/stats`
- [Plan a creative video](https://docs.zvid.io/docs/endpoints/plan-creative-video/): `POST /api/render/creative-plan/api-key`
- [Submit render job](https://docs.zvid.io/docs/endpoints/submit-render-job/): `POST /api/render/api-key`
- [List render jobs](https://docs.zvid.io/docs/endpoints/list-render-jobs/): `GET /api/jobs`
- [Get render job status](https://docs.zvid.io/docs/endpoints/get-render-job/): `GET /api/jobs/{id}`
- [Submit image render job](https://docs.zvid.io/docs/endpoints/submit-image-render-job/): `POST /api/render/image/api-key`
- [Submit bulk render](https://docs.zvid.io/docs/endpoints/submit-bulk-render/): `POST /api/render/bulk/api-key`
- [Submit bulk image render](https://docs.zvid.io/docs/endpoints/submit-image-bulk-render/): `POST /api/render/image/bulk/api-key`
- [List bulk renders](https://docs.zvid.io/docs/endpoints/list-bulk-renders/): `GET /api/render/bulk`
- [Get bulk render status](https://docs.zvid.io/docs/endpoints/get-bulk-render/): `GET /api/render/bulk/{id}`
- [List templates](https://docs.zvid.io/docs/endpoints/list-templates/): `GET /api/templates`
- [Create template](https://docs.zvid.io/docs/endpoints/create-template/): `POST /api/templates`
- [Get template](https://docs.zvid.io/docs/endpoints/get-template/): `GET /api/templates/{id}`
- [Update template](https://docs.zvid.io/docs/endpoints/update-template/): `PUT /api/templates/{id}`
- [Archive template](https://docs.zvid.io/docs/endpoints/delete-template/): `DELETE /api/templates/{id}`
- [Resolve and validate template](https://docs.zvid.io/docs/endpoints/preview-template/): `POST /api/templates/{id}/preview`
- [List webhooks](https://docs.zvid.io/docs/endpoints/list-webhooks/): `GET /api/webhooks`
- [Create webhook](https://docs.zvid.io/docs/endpoints/create-webhook/): `POST /api/webhooks`
- [Get webhook](https://docs.zvid.io/docs/endpoints/get-webhook/): `GET /api/webhooks/{id}`
- [Update webhook](https://docs.zvid.io/docs/endpoints/update-webhook/): `PUT /api/webhooks/{id}`
- [Delete webhook](https://docs.zvid.io/docs/endpoints/delete-webhook/): `DELETE /api/webhooks/{id}`
- [List webhook deliveries](https://docs.zvid.io/docs/endpoints/list-webhook-deliveries/): `GET /api/webhooks/{id}/deliveries`
- [Send test delivery](https://docs.zvid.io/docs/endpoints/test-webhook/): `POST /api/webhooks/{id}/test`
- [List uploads](https://docs.zvid.io/docs/endpoints/list-uploads/): `GET /api/uploads`
- [Upload a file](https://docs.zvid.io/docs/endpoints/create-upload/): `POST /api/uploads`
- [Delete upload](https://docs.zvid.io/docs/endpoints/delete-upload/): `DELETE /api/uploads/{id}`
- [List projects](https://docs.zvid.io/docs/endpoints/list-projects/): `GET /api/projects`
- [Create project](https://docs.zvid.io/docs/endpoints/create-project/): `POST /api/projects`
- [Get project](https://docs.zvid.io/docs/endpoints/get-project/): `GET /api/projects/{id}`
- [Update project](https://docs.zvid.io/docs/endpoints/update-project/): `PUT /api/projects/{id}`
- [Delete project](https://docs.zvid.io/docs/endpoints/delete-project/): `DELETE /api/projects/{id}`
- [Duplicate template](https://docs.zvid.io/docs/endpoints/duplicate-template/): `POST /api/templates/{id}/duplicate`
- [Validate render request](https://docs.zvid.io/docs/endpoints/validate-render-job/): `POST /api/render/validate/api-key`
- [Get live render schema](https://docs.zvid.io/docs/endpoints/get-render-schema/): `GET /api/render/schema/api-key`
- [List supported elements](https://docs.zvid.io/docs/endpoints/list-render-elements/): `GET /api/render/elements/api-key`
- [Get element reference](https://docs.zvid.io/docs/endpoints/get-render-element/): `GET /api/render/elements/{type}/api-key`
- [List authoring examples](https://docs.zvid.io/docs/endpoints/list-render-examples/): `GET /api/render/examples/api-key`
- [Get authoring example](https://docs.zvid.io/docs/endpoints/get-render-example/): `GET /api/render/examples/{name}/api-key`
- [Repair project JSON](https://docs.zvid.io/docs/endpoints/repair-render-project/): `POST /api/render/repair/api-key`
- [Get MCP preferences](https://docs.zvid.io/docs/endpoints/get-mcp-preferences/): `GET /api/mcp/preferences`
- [Search stock media](https://docs.zvid.io/docs/endpoints/search-stock-media/): `GET /api/stock/search`
- [List creative library items](https://docs.zvid.io/docs/endpoints/list-library-items/): `GET /api/library/{kind}`
- [Get creative library metadata](https://docs.zvid.io/docs/endpoints/get-library-item/): `GET /api/library/{kind}/{slug}`
- [Get creative library content](https://docs.zvid.io/docs/endpoints/get-library-content/): `GET /api/library/{kind}/{slug}/content`