Pipeline

• 200a page of PipelineRun

  A page of pipeline runs.

• 400

  INVALID_REQUEST. The request could not be parsed, or a parameter is not usable: bad JSON, an unknown query parameter value, or a missing required header.

• 401

  INVALID_API_KEY, API_KEY_REVOKED or API_KEY_EXPIRED. There is no key, or it is not usable. This response never distinguishes "no such key" from "wrong key", so a caller cannot probe for valid keys.

• 403

  INSUFFICIENT_SCOPE. The key is valid but does not carry the scope this operation requires, or its creator's permissions no longer cover it.

  This is the only 403 in the API. In particular it is never returned for an object belonging to another Site: that case is always 404, so this response never reveals that something exists.

• 429

  RATE_LIMIT_EXCEEDED. Back off and honour Retry-After.

  Limits are per key, per minute, by endpoint class. Writes are limited harder than reads because they cost more to serve, and pipeline runs hardest of all because they cost real money.

  Class	Endpoints	Limit
  read	every GET	600 per minute
  write	POST, PATCH and DELETE on content, taxonomy, keys and webhooks	120 per minute
  upload	POST /media/upload-url	60 per minute
  pipeline	POST /pipeline/runs	10 per minute

  Every response carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset, so you can slow down before you are refused rather than after.

  • RateLimit-Limit Requests permitted in the current window for this endpoint class.
  • RateLimit-Remaining Requests left in the current window.
  • RateLimit-Reset Unix seconds at which the window resets.
  • Retry-After Seconds to wait before retrying.
• 500

  INTERNAL_ERROR. Something failed on our side. The message is deliberately generic; the detail is in our logs against the request_id in the body, so quote it if you contact support.

  Safe to retry, and safer still with the same Idempotency-Key, which guarantees you do not create a second object if the first request actually succeeded.

• 503

  MAINTENANCE. Writes are paused, either platform wide or for your Site. Reads usually keep working, and your published blog is served from cache and stays up. Retry after the window given in Retry-After.

  • Retry-After Seconds to wait before retrying.

curl https://api.writavo.com/v1/pipeline/runs \
  -H "Authorization: Bearer wv_sk_EXAMPLE0000000000000000000000000000"

Generated from the specification, so it shows the path, the required headers and the body shape. The guides carry the end to end examples.

• 202

  The run was accepted and queued.

  Field	Type	Notes
  id*	uuid
  status*	"queued"
  requested_at*	date-time
  estimated_start_at	date-time | null	When the engine expects to pick this up. Advisory.

• 400

  INVALID_REQUEST. The request could not be parsed, or a parameter is not usable: bad JSON, an unknown query parameter value, or a missing required header.

• 401

  INVALID_API_KEY, API_KEY_REVOKED or API_KEY_EXPIRED. There is no key, or it is not usable. This response never distinguishes "no such key" from "wrong key", so a caller cannot probe for valid keys.

• 402

  NOT_ENTITLED, INSUFFICIENT_CREDITS or SPEND_CAP_REACHED. The request was understood and you were permitted to make it, but it cannot be paid for. Three distinct codes because the fixes differ: upgrade the plan, top up credits, or raise the Site's cap.

  These are 402 rather than 403 on purpose. A 403 says "you may not"; these all say "not yet, and here is how to change that".

• 403

  INSUFFICIENT_SCOPE. The key is valid but does not carry the scope this operation requires, or its creator's permissions no longer cover it.

  This is the only 403 in the API. In particular it is never returned for an object belonging to another Site: that case is always 404, so this response never reveals that something exists.

• 409

  SLUG_CONFLICT, IDEMPOTENCY_KEY_CONFLICT, IDEMPOTENCY_KEY_IN_FLIGHT or CONFLICT. The request is valid but collides with the current state: a slug is taken, an idempotency key was reused with a different body or is still in flight, or the object moved while you were working on it. Read code to tell which, then re-read and retry.

• 422

  VALIDATION_FAILED. The request parsed but the values are not acceptable. error.fields maps each offending field to a message you can put next to the input.

  Common causes: publishing without a title, slug or content; scheduling in the past; and sending status on a create or update, which is how the API refuses to let a client push content into the AI pipeline.

• 429

  RATE_LIMIT_EXCEEDED. Back off and honour Retry-After.

  Limits are per key, per minute, by endpoint class. Writes are limited harder than reads because they cost more to serve, and pipeline runs hardest of all because they cost real money.

  Class	Endpoints	Limit
  read	every GET	600 per minute
  write	POST, PATCH and DELETE on content, taxonomy, keys and webhooks	120 per minute
  upload	POST /media/upload-url	60 per minute
  pipeline	POST /pipeline/runs	10 per minute

  Every response carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset, so you can slow down before you are refused rather than after.

  • RateLimit-Limit Requests permitted in the current window for this endpoint class.
  • RateLimit-Remaining Requests left in the current window.
  • RateLimit-Reset Unix seconds at which the window resets.
  • Retry-After Seconds to wait before retrying.
• 500

  INTERNAL_ERROR. Something failed on our side. The message is deliberately generic; the detail is in our logs against the request_id in the body, so quote it if you contact support.

  Safe to retry, and safer still with the same Idempotency-Key, which guarantees you do not create a second object if the first request actually succeeded.

• 503

  MAINTENANCE. Writes are paused, either platform wide or for your Site. Reads usually keep working, and your published blog is served from cache and stays up. Retry after the window given in Retry-After.

  • Retry-After Seconds to wait before retrying.

curl -X POST https://api.writavo.com/v1/pipeline/runs \
  -H "Authorization: Bearer wv_sk_EXAMPLE0000000000000000000000000000" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

Generated from the specification, so it shows the path, the required headers and the body shape. The guides carry the end to end examples.

• 200PipelineRun

  The pipeline run.

• 401

  INVALID_API_KEY, API_KEY_REVOKED or API_KEY_EXPIRED. There is no key, or it is not usable. This response never distinguishes "no such key" from "wrong key", so a caller cannot probe for valid keys.

• 403

  INSUFFICIENT_SCOPE. The key is valid but does not carry the scope this operation requires, or its creator's permissions no longer cover it.

  This is the only 403 in the API. In particular it is never returned for an object belonging to another Site: that case is always 404, so this response never reveals that something exists.

• 404

  NOT_FOUND. Either no such object exists, or it exists and belongs to a different Site.

  These two cases are deliberately indistinguishable, and neither ever returns 403. A 403 would confirm the object exists, which would let anyone with a valid key enumerate other customers' content by id. If you are certain the id is right, check you are using the key for the correct Site.

• 429

  RATE_LIMIT_EXCEEDED. Back off and honour Retry-After.

  Limits are per key, per minute, by endpoint class. Writes are limited harder than reads because they cost more to serve, and pipeline runs hardest of all because they cost real money.

  Class	Endpoints	Limit
  read	every GET	600 per minute
  write	POST, PATCH and DELETE on content, taxonomy, keys and webhooks	120 per minute
  upload	POST /media/upload-url	60 per minute
  pipeline	POST /pipeline/runs	10 per minute

  Every response carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset, so you can slow down before you are refused rather than after.

  • RateLimit-Limit Requests permitted in the current window for this endpoint class.
  • RateLimit-Remaining Requests left in the current window.
  • RateLimit-Reset Unix seconds at which the window resets.
  • Retry-After Seconds to wait before retrying.
• 500

  INTERNAL_ERROR. Something failed on our side. The message is deliberately generic; the detail is in our logs against the request_id in the body, so quote it if you contact support.

  Safe to retry, and safer still with the same Idempotency-Key, which guarantees you do not create a second object if the first request actually succeeded.

• 503

  MAINTENANCE. Writes are paused, either platform wide or for your Site. Reads usually keep working, and your published blog is served from cache and stays up. Retry after the window given in Retry-After.

  • Retry-After Seconds to wait before retrying.

curl https://api.writavo.com/v1/pipeline/runs/3f1b0c7a-0000-4000-8000-000000000001 \
  -H "Authorization: Bearer wv_sk_EXAMPLE0000000000000000000000000000"

Generated from the specification, so it shows the path, the required headers and the body shape. The guides carry the end to end examples.

• 200a page of QueueItem

  A page of queue items.

• 400

  INVALID_REQUEST. The request could not be parsed, or a parameter is not usable: bad JSON, an unknown query parameter value, or a missing required header.

• 401

  INVALID_API_KEY, API_KEY_REVOKED or API_KEY_EXPIRED. There is no key, or it is not usable. This response never distinguishes "no such key" from "wrong key", so a caller cannot probe for valid keys.

• 403

  INSUFFICIENT_SCOPE. The key is valid but does not carry the scope this operation requires, or its creator's permissions no longer cover it.

  This is the only 403 in the API. In particular it is never returned for an object belonging to another Site: that case is always 404, so this response never reveals that something exists.

• 429

  RATE_LIMIT_EXCEEDED. Back off and honour Retry-After.

  Limits are per key, per minute, by endpoint class. Writes are limited harder than reads because they cost more to serve, and pipeline runs hardest of all because they cost real money.

  Class	Endpoints	Limit
  read	every GET	600 per minute
  write	POST, PATCH and DELETE on content, taxonomy, keys and webhooks	120 per minute
  upload	POST /media/upload-url	60 per minute
  pipeline	POST /pipeline/runs	10 per minute

  Every response carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset, so you can slow down before you are refused rather than after.

  • RateLimit-Limit Requests permitted in the current window for this endpoint class.
  • RateLimit-Remaining Requests left in the current window.
  • RateLimit-Reset Unix seconds at which the window resets.
  • Retry-After Seconds to wait before retrying.
• 500

  INTERNAL_ERROR. Something failed on our side. The message is deliberately generic; the detail is in our logs against the request_id in the body, so quote it if you contact support.

  Safe to retry, and safer still with the same Idempotency-Key, which guarantees you do not create a second object if the first request actually succeeded.

• 503

  MAINTENANCE. Writes are paused, either platform wide or for your Site. Reads usually keep working, and your published blog is served from cache and stays up. Retry after the window given in Retry-After.

  • Retry-After Seconds to wait before retrying.

curl https://api.writavo.com/v1/pipeline/queue \
  -H "Authorization: Bearer wv_sk_EXAMPLE0000000000000000000000000000"

Generated from the specification, so it shows the path, the required headers and the body shape. The guides carry the end to end examples.