Quickstart - Plume

This walks through going from a fresh deployment to a published entry your frontend can read. Set B to your deployment URL.

B=https://plume.ankurai.com

Create the first admin

Setup runs once. If a SETUP_TOKEN was configured, pass it as the x-setup-token header.

TOKEN=$(curl -s -X POST $B/admin/setup \
  -H 'content-type: application/json' \
  -H 'x-setup-token: YOUR_SETUP_TOKEN' \
  -d '{"email":"you@example.com","password":"a-strong-password"}' | jq -r .token)

After this, the setup endpoint is closed and returns 409.

Define a content type

Content types are field definitions. Mark a type public to allow unauthenticated reads of its published entries.

curl -s -X POST $B/admin/content-types \
  -H "authorization: Bearer $TOKEN" -H 'content-type: application/json' -d '{
    "apiId": "article",
    "public": true,
    "fields": [
      { "name": "title", "type": "string", "required": true },
      { "name": "slug",  "type": "string", "unique": true },
      { "name": "body",  "type": "richtext" }
    ]
  }'

Create and publish an entry

New entries start as drafts. Publishing makes them visible to public and read-key callers.

ID=$(curl -s -X POST $B/graphql \
  -H "authorization: Bearer $TOKEN" -H 'content-type: application/json' \
  -d '{"query":"mutation{createArticle(data:{title:\"Hello\",slug:\"hello\"}){id}}"}' \
  | jq -r .data.createArticle.id)

curl -s -X POST $B/graphql \
  -H "authorization: Bearer $TOKEN" -H 'content-type: application/json' \
  -d "{\"query\":\"mutation{publishArticle(id:\\\"$ID\\\"){status}}\"}"

Read it from your frontend

Public types need no key. For non-public types, generate a read key (see Authentication).

curl -s -X POST $B/graphql -H 'content-type: application/json' \
  -d '{"query":"query{articles{title slug status}}"}'

You now have a live content type, a published entry, and a public read endpoint. Explore the schema interactively at /graphql in a browser.

Plume Content types