REST API Overview & AuthenticationCopy Anchor Link

ZyVOP exposes a developer-first REST API enabling you to publish and syndicate articles programmatically from static site builders, headless CMS webhooks (Sanity, Strapi, Contentful), or automated Git pipelines.

Base URLCopy Anchor Link

All requests must be made over HTTPS to:

https://zyvop.com/api/v1

AuthenticationCopy Anchor Link

Authentication is performed using Developer Tokens. Every developer token begins with the prefix zv_ followed by 48 hexadecimal characters.

Authorization: Bearer zv_<48-hex-character-token>

Example cURL RequestCopy Anchor Link

curl -X POST https://zyvop.com/api/v1/articles \
  -H "Authorization: Bearer $ZYVOP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "---\ntitle: \"Distributed Tracing\"\ncanonical_url: \"https://myblog.dev/tracing\"\n---\n\n# Distributed Tracing\n\nDeep dive into OpenTelemetry..."
  }'

Idempotent UpsertsCopy Anchor Link

The ZyVOP API is natively idempotent. When you send an article payload, ZyVOP determines whether to create a new post or update an existing one authored by you by matching:

1. Frontmatter id or body id
2. Frontmatter slug or body slug
3. Frontmatter canonical_url
4. Post title

If a matching post exists in your account, it updates the content and returns "action": "updated". Otherwise, it creates a new post and returns "action": "created". This makes CI/CD workflows safe against duplicate posts on rerun.

EndpointsCopy Anchor Link