Documentation menu

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#

base url
https://api.writavo.com/v1

Every 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.

success
{
  "ok": true,
  "data": { }
}

Every failed response has this shape.

error
{
  "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"
  }
}
Branch on 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#