reference
API reference
Every operation in Writavo Content API v1.0.0. Generated from openapi.yaml, which you can download and point a client generator at.
Base URL#
https://api.writavo.com/v1Every request is authenticated. The Site is resolved from your key, so no path or parameter names a Site anywhere in this reference.
The response envelope#
Every successful response has this shape. Check ok before reading data.
{
"ok": true,
"data": { }
}Every failed response has this shape.
{
"ok": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "Add a title before publishing.",
"fields": { "title": "Add a title before publishing." },
"request_id": "0f2a8c31-0000-4000-8000-00000000abcd"
}
}error.code, never on the message. Codes are stable within /v1; wording is not. Each one has its own section on the errors page.All 50 operations#
Meta
Connectivity, Site information, content types, limits and usage.
Articles
The content spine. Create, edit, organise, publish and schedule.
- GET
/articlesList articles - POST
/articlesCreate an article - GET
/articles/{id}Read one article - PATCH
/articles/{id}Update an article - DELETE
/articles/{id}Delete an article - POST
/articles/{id}/publishPublish an article - POST
/articles/{id}/unpublishUnpublish an article - POST
/articles/{id}/scheduleSchedule an article - POST
/articles/{id}/cancel-scheduleCancel a scheduled publish
Categories
The closed taxonomy. Exactly one category per article.
Tags
The cross cutting taxonomy. Many tags per article.
Authors
The byline roster for a Site.
Media
The media library. Two step upload, then registration.
Pipeline
The AI generation engine. The only billable surface in this API.
API keys
Key management. Specified here, implemented in API-2.
Webhooks
Outbound event delivery. Register an HTTPS endpoint, subscribe it to events, and receive a signed POST whenever your content changes, from this API or from the dashboard.
- GET
/webhooksList webhook endpoints - POST
/webhooksCreate a webhook endpoint - GET
/webhooks/{id}Read one webhook endpoint - PATCH
/webhooks/{id}Update a webhook endpoint - DELETE
/webhooks/{id}Delete a webhook endpoint - POST
/webhooks/{id}/rotate-secretRotate the signing secret - GET
/webhooks/{id}/deliveriesList deliveries for an endpoint - POST
/webhooks/{id}/deliveries/{delivery_id}/redeliverSend one delivery again