Getting Started

Base URL

All public content requests go to:

https://vinecms.tech/api/public/v1

API Versioning

The current stable public API version is v1. Use the explicit versioned route format:

https://vinecms.tech/api/public/v1/{API_KEY}/{resource}

Example:

https://vinecms.tech/api/public/v1/{API_KEY}/posts

Authentication

The Vine public API uses path-based API key authentication.

Getting Your API Key

Create or copy an API key from your workspace inside Vine.

Using Your API Key

Replace {API_KEY} with the real key value:

# Before
https://vinecms.tech/api/public/v1/{API_KEY}/posts

# After
https://vinecms.tech/api/public/v1/your-real-api-key/posts

Making Requests

No special headers are required.

You can call the API from:

• Browser: Use fetch() or XMLHttpRequest
• cURL: Use the command line examples provided in each endpoint
• Any HTTP client: Standard GET requests work out of the box

Example Request

Here's a simple example using cURL:

curl "https://vinecms.tech/api/public/v1/{API_KEY}/posts"

or using JavaScript:

const response = await fetch(
  'https://vinecms.tech/api/public/v1/{API_KEY}/posts'
);

if (!response.ok) {
  const error = await response.json();
  throw new Error(error.error || 'Request failed');
}

const data = await response.json();
console.log(data.posts);

Example Response

{
  "ok": true,
  "posts": []
}

Response Format

All successful responses return JSON data. Error responses also use JSON with a message field describing the issue.

Success Response

{
  "ok": true,
}

Error Response

{
  "ok": false,
  "error": "Invalid API key"
}

Health And Status Checks

Use these endpoints to verify the API surface is live:

curl "https://vinecms.tech/api/health"
curl "https://vinecms.tech/api/public/v1/status"

Next Steps

• Read Posts for content retrieval
• Read Response Shapes for the exact payloads
• Read Troubleshooting for common integration issues