Pluma
Docs index
docs/start/first-5-minutes.md View markdown →

First 5 minutes

From zero to reading your first content by API. If you'd rather have your agent do it, jump to Invite your agent: it does these steps by itself.

1. Create the site

Sign in to Pluma and create a site. Its slug (for example acton-estero) goes in every API URL. See Create the site.

2. Add something and publish it

In Model, create an event type with a title field. In Content, create an event and click Publish. Drafts don't come out of the Delivery API.

3. Create a read key

In Keys, create a delivery key. The token is shown only once: copy it.

export PLUMA_KEY=pluma_dlv_…

4. Read your content

curl https://pluma.so/api/v1/spaces/acton-estero/entries?content_type=event -H "Authorization: Bearer $PLUMA_KEY"
{ "sys": { "type": "Array" }, "total": 1, "skip": 0, "limit": 100,
  "items": [ { "sys": { "id": "1", "type": "Entry", "content_type": "event", "status": "published" }, "fields": { "title": "Open House" } } ] }

5. Take it to your site

If something fails, the error says what happened and how to fix it, with a link to its page in Errors.