reference
Authors
The byline roster for a Site.
/authorsList authors#
- Scope
- authors:read
- Rate limit
- 600/min (read)
- Publishable key
- allowed
- Dashboard permission
- taxonomy.read
The byline roster for the Site.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| cursor | query | string | The opaque cursor from |
| limit | query | integer | Page size. Values above the maximum are clamped rather than rejected, so a client asking for a thousand rows gets a hundred and a default 20 |
| fields | query | string | Comma separated field allow list. Default projection: |
Responses
- 200a page of Author
A page of authors.
- 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_REVOKEDorAPI_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 honourRetry-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-url60 per minute pipeline POST /pipeline/runs10 per minute Every response carries
RateLimit-Limit,RateLimit-RemainingandRateLimit-Reset, so you can slow down before you are refused rather than after.RateLimit-LimitRequests permitted in the current window for this endpoint class.RateLimit-RemainingRequests left in the current window.RateLimit-ResetUnix seconds at which the window resets.Retry-AfterSeconds to wait before retrying.
- 500
INTERNAL_ERROR. Something failed on our side. The message is deliberately generic; the detail is in our logs against therequest_idin 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 inRetry-After.Retry-AfterSeconds to wait before retrying.
Request shape
curl https://api.writavo.com/v1/authors \
-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.
/authorsCreate an author#
- Scope
- authors:write
- Rate limit
- 120/min (write)
- Publishable key
- refused
- Dashboard permission
- taxonomy.manage
is_ai_generated marks a persona rather than a real person. It defaults to true because that is what the generation pipeline creates. Set it to false for a human byline, and be accurate about it: it is what your disclosure copy keys off.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| Idempotency-Key* | header | string | A unique key you generate per logical operation, 1 to 255 printable ASCII characters. A UUID is the obvious choice. Retry with the same key and the same body and you get the original response replayed rather than a second object. This is what makes a network timeout safe: you never know whether the first request landed, so you retry with the same key and find out. Same key with a different body is Keys are scoped to the Site and the endpoint, and are retained for 24 hours. After that the same key is a new operation. |
Request body
Shape: AuthorWrite
| Field | Type | Notes |
|---|---|---|
| name* | string | |
| bio | string | null | |
| avatar_url | uri | null | |
| is_ai_generated | boolean | |
| is_default | boolean |
Responses
- 201Author
The author was created.
LocationThe canonical URL of the new author.ETagThe concurrency token.
- 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_REVOKEDorAPI_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.
- 409
SLUG_CONFLICT,IDEMPOTENCY_KEY_CONFLICT,IDEMPOTENCY_KEY_IN_FLIGHTorCONFLICT. 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. Readcodeto tell which, then re-read and retry. - 422
VALIDATION_FAILED. The request parsed but the values are not acceptable.error.fieldsmaps 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
statuson 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 honourRetry-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-url60 per minute pipeline POST /pipeline/runs10 per minute Every response carries
RateLimit-Limit,RateLimit-RemainingandRateLimit-Reset, so you can slow down before you are refused rather than after.RateLimit-LimitRequests permitted in the current window for this endpoint class.RateLimit-RemainingRequests left in the current window.RateLimit-ResetUnix seconds at which the window resets.Retry-AfterSeconds to wait before retrying.
- 500
INTERNAL_ERROR. Something failed on our side. The message is deliberately generic; the detail is in our logs against therequest_idin 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 inRetry-After.Retry-AfterSeconds to wait before retrying.
Request shape
curl -X POST https://api.writavo.com/v1/authors \
-H "Authorization: Bearer wv_sk_EXAMPLE0000000000000000000000000000" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"name": "<name>"
}'Generated from the specification, so it shows the path, the required headers and the body shape. The guides carry the end to end examples.
/authors/{id}Read one author#
- Scope
- authors:read
- Rate limit
- 600/min (read)
- Publishable key
- allowed
- Another Site's id
- 404
- Dashboard permission
- taxonomy.read
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| id* | path | uuid |
Responses
- 200Author
The author.
ETagThe concurrency token.
- 401
INVALID_API_KEY,API_KEY_REVOKEDorAPI_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 honourRetry-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-url60 per minute pipeline POST /pipeline/runs10 per minute Every response carries
RateLimit-Limit,RateLimit-RemainingandRateLimit-Reset, so you can slow down before you are refused rather than after.RateLimit-LimitRequests permitted in the current window for this endpoint class.RateLimit-RemainingRequests left in the current window.RateLimit-ResetUnix seconds at which the window resets.Retry-AfterSeconds to wait before retrying.
- 500
INTERNAL_ERROR. Something failed on our side. The message is deliberately generic; the detail is in our logs against therequest_idin 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 inRetry-After.Retry-AfterSeconds to wait before retrying.
Request shape
curl https://api.writavo.com/v1/authors/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.
/authors/{id}Update an author#
- Scope
- authors:write
- Rate limit
- 120/min (write)
- Publishable key
- refused
- Another Site's id
- 404
- Dashboard permission
- taxonomy.manage
Setting is_default: true clears the flag on whichever author held it, because a Site has at most one default byline. Setting it to false on the current default leaves the Site with none.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| id* | path | uuid | |
| If-Match | header | string | The Optional in v1 for compatibility. Omitting it means last write wins. Send it. |
Request body
Shape: AuthorUpdate
| Field | Type | Notes |
|---|---|---|
| name | string | |
| bio | string | null | |
| avatar_url | uri | null | |
| is_ai_generated | boolean | |
| is_default | boolean |
Responses
- 200Author
The updated author.
ETagThe new concurrency token.
- 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_REVOKEDorAPI_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.
- 412
PRECONDITION_FAILED. YourIf-Matchdid not match the current version, meaning somebody edited the object since you read it. Nothing was written. Re-read, merge, and retry with the newETag. - 422
VALIDATION_FAILED. The request parsed but the values are not acceptable.error.fieldsmaps 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
statuson 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 honourRetry-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-url60 per minute pipeline POST /pipeline/runs10 per minute Every response carries
RateLimit-Limit,RateLimit-RemainingandRateLimit-Reset, so you can slow down before you are refused rather than after.RateLimit-LimitRequests permitted in the current window for this endpoint class.RateLimit-RemainingRequests left in the current window.RateLimit-ResetUnix seconds at which the window resets.Retry-AfterSeconds to wait before retrying.
- 500
INTERNAL_ERROR. Something failed on our side. The message is deliberately generic; the detail is in our logs against therequest_idin 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 inRetry-After.Retry-AfterSeconds to wait before retrying.
Request shape
curl -X PATCH https://api.writavo.com/v1/authors/3f1b0c7a-0000-4000-8000-000000000001 \
-H "Authorization: Bearer wv_sk_EXAMPLE0000000000000000000000000000" \
-H 'If-Match: W/"1767225600000"' \
-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.
/authors/{id}Delete an author#
- Scope
- authors:write
- Rate limit
- 120/min (write)
- Publishable key
- refused
- Another Site's id
- 404
- Dashboard permission
- taxonomy.manage
Articles by this author are not deleted. Their author_id becomes null, so they stay published and lose their byline.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| id* | path | uuid |
Responses
- 204
Deleted. No body.
- 401
INVALID_API_KEY,API_KEY_REVOKEDorAPI_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 honourRetry-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-url60 per minute pipeline POST /pipeline/runs10 per minute Every response carries
RateLimit-Limit,RateLimit-RemainingandRateLimit-Reset, so you can slow down before you are refused rather than after.RateLimit-LimitRequests permitted in the current window for this endpoint class.RateLimit-RemainingRequests left in the current window.RateLimit-ResetUnix seconds at which the window resets.Retry-AfterSeconds to wait before retrying.
- 500
INTERNAL_ERROR. Something failed on our side. The message is deliberately generic; the detail is in our logs against therequest_idin 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 inRetry-After.Retry-AfterSeconds to wait before retrying.
Request shape
curl -X DELETE https://api.writavo.com/v1/authors/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.
Schemas
The shapes this resource sends and returns. Unknown fields may be added within /v1, so tolerate them.
Author#
| Field | Type | Notes |
|---|---|---|
| id* | uuidread only | |
| name* | string | |
| bio | string | null | |
| avatar_url | uri | null | |
| is_ai_generated | boolean | True for a persona the engine created, false for a real person. |
| is_default | boolean | The byline used when an article names no author. At most one per Site. |
| created_at | date-timeread only |
AuthorUpdate#
| Field | Type | Notes |
|---|---|---|
| name | string | |
| bio | string | null | |
| avatar_url | uri | null | |
| is_ai_generated | boolean | |
| is_default | boolean |
AuthorWrite#
| Field | Type | Notes |
|---|---|---|
| name* | string | |
| bio | string | null | |
| avatar_url | uri | null | |
| is_ai_generated | boolean | |
| is_default | boolean |