Quickstart

Make your first authenticated request in a couple of minutes.

1. Create a project & key

On your dashboard, create a project and open it. Note its id (<YOUR_PROJECT_ID> below), then choose Issue key to get a secret. The secret is shown once.

2. Create a collection and a document (server-side)

Schema management needs an API key. This creates a collection with public read/create, then adds a document:

curl
curl -X POST "https://base.finiteskills.com/v1/databases/main/collections" \
  -H "X-Appwrite-Project: <YOUR_PROJECT_ID>" \
  -H "X-Appwrite-Key: <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"collectionId":"notes","name":"Notes","permissions":["read(\"any\")","create(\"any\")"]}'

curl -X POST "https://base.finiteskills.com/v1/databases/main/collections/notes/documents" \
  -H "X-Appwrite-Project: <YOUR_PROJECT_ID>" \
  -H "X-Appwrite-Key: <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"documentId":"unique()","data":{"title":"Hello","done":false}}'

(The database id main is created automatically the first time you reference it.)

3. Read it back

curl
curl "https://base.finiteskills.com/v1/databases/main/collections/notes/documents" \
  -H "X-Appwrite-Project: <YOUR_PROJECT_ID>"

Next

Use a client SDK in your app, learn the query operators, or add user accounts.