Reference
Marketing
Marketing videos generated from a scan of a website: sources, projects, revisions, generations and exports.
Operations
27 operations: 13 that read and 14 that change something. Every path is relative to the API base URL. Open one for its parameters, its response shape and the refusals it can answer.
| Endpoint | Scopes | Rate limit |
|---|---|---|
GET /marketing/brand-kit The account's brand kit | marketing:read | read, 600/min |
PUT /marketing/brand-kit Save the account's brand kit | marketing:write idempotency key | write, 120/min |
POST /marketing/exports/{id}/cancel Stop an export | marketing:export idempotency key | write, 120/min |
POST /marketing/projects/{id}/exports Cut the finished video | marketing:export async idempotency key | charge, 20/min |
GET /marketing/exports/{id}/download A link to a finished export or one of its sidecars | marketing:read | read, 600/min |
GET /marketing/exports/{id} One marketing export | marketing:read | read, 600/min |
GET /marketing/exports The account's marketing exports | marketing:read | read, 600/min |
POST /marketing/exports/quote What an export would cost | marketing:read | read, 600/min |
POST /marketing/generations/{id}/cancel Stop a generation | marketing:write idempotency key | write, 120/min |
POST /marketing/generations Turn a scanned website into a marketing project | marketing:write async idempotency key | expensive, 20/min |
GET /marketing/generations/{id} One generation | marketing:read | read, 600/min |
GET /marketing/generations The account's generations | marketing:read | read, 600/min |
POST /marketing/generations/preflight Would this generation be accepted? | marketing:write | expensive, 20/min |
POST /marketing/generations/{id}/retry Run a failed generation again | marketing:write async idempotency key | expensive, 20/min |
POST /marketing/projects Start a marketing project | marketing:write idempotency key | write, 120/min |
DELETE /marketing/projects/{id} Delete a marketing project | marketing:write idempotency key | write, 120/min |
GET /marketing/projects/{id} One marketing project | marketing:read | read, 600/min |
GET /marketing/projects The account's marketing projects | marketing:read | read, 600/min |
POST /marketing/projects/{id}/revisions Rework a project | marketing:write idempotency key | write, 120/min |
POST /marketing/projects/{id}/edits Change a project with a sentence | marketing:write idempotency key | expensive, 20/min |
GET /marketing/projects/{id}/revisions A project's revisions | marketing:read | read, 600/min |
POST /marketing/sources/{id}/cancel Stop a scan | marketing:write idempotency key | write, 120/min |
POST /marketing/sources Scan a website | marketing:write async idempotency key | expensive, 20/min |
DELETE /marketing/sources/{id} Delete a website source | marketing:write idempotency key | write, 120/min |
GET /marketing/sources/{id} One website source | marketing:read | read, 600/min |
GET /marketing/sources The account's website sources | marketing:read | read, 600/min |
POST /marketing/sources/{id}/refresh Scan a website again | marketing:write async idempotency key | expensive, 20/min |