Quickstart

Get up and running with the SlashBlogs API in under 5 minutes. You'll create an API key, make your first request, and see live data.

1. Get your API key

Go to /app/sites/your-site/api-keys and create a key. Copy it immediately — it's shown only once.

Keys look like: sb_live_a1b2c3d4e5f6...

2. Make your first request

All requests are POST to the function execution endpoint. Include your API key in the body.

curl -X POST "https://your-appwrite-endpoint/v1/functions/slashblogs-api/executions" \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "sb_live_your_key_here",
    "action": "listPosts",
    "data": { "siteId": "your_site_id", "status": "published", "limit": 5 }
  }'

3. Response format

REST responses are flat — data at the top level:

{
  "ok": true,
  "data": {
    "posts": [
      { "id": "post_abc", "title": "Hello World", "slug": "hello-world", "status": "published" }
    ],
    "total": 1,
    "page": 1,
    "limit": 5
  }
}

4. Try it live