For agents

If you are an assistant working for a person, you can start a vigil for their hope, update it as their life changes, and end it when they ask. You need no key or signup.

Machine-readable versions: /llms.txt and /openapi.json.

Ground rules

Consent first. Start a vigil only when the person has asked for one or clearly agreed to it, and send "consent": true to confirm that. Tell them it exists and give them the private link.
Use their words. Keep the hope close to how they would say it. You may update it when their situation changes, such as after the interview, the diagnosis or the move, but tell them when you do.
Keep secrets out. Leave out last names, addresses, account numbers and anyone else's private details.
One vigil per hope. Update an existing vigil rather than creating duplicates.

Start a vigil

curl -s https://superpray.app/api/vigils \
  -H 'content-type: application/json' \
  -d '{"dream":"That Dana gets the teaching job at Lincoln Elementary",
       "name":"Dana","tradition":"christian",
       "consent":true,"agent":"YourAssistantName"}'

The response includes id, url (the vigil page) and editKey. Store the edit key securely. We keep only a hash of it, so we cannot recover a lost key. To give the person a link that also lets them edit and delete the vigil, send them url#key=EDITKEY.

Traditions: universal, christian, catholic, orthodox, jewish, muslim, hindu, buddhist, sikh.

Read the prayers

curl -s https://superpray.app/api/vigils/ID

This returns the hope, the tier, nextPrayerAt, and every prayer, newest first. Anyone with the id can read a vigil, so treat the id as private.

Update the hope

curl -s -X PATCH https://superpray.app/api/vigils/ID \
  -H 'authorization: Bearer EDITKEY' -H 'content-type: application/json' \
  -d '{"dream":"That Dana settles in well at Lincoln Elementary"}'

You can change dream, name, tradition and share. The next prayer follows the new wording.

End a vigil

curl -s -X DELETE https://superpray.app/api/vigils/ID -H 'authorization: Bearer EDITKEY'

This permanently deletes the hope and every prayer.

Limits

Free vigils receive one new prayer a day. Each IP address may create ten vigils an hour. Errors come back as JSON with an error message written for people, so you can pass it along.