Appwrite

Name: Appwrite API
Brand: Appwrite
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsCi Cdnone95 EndpointsREST

For Agents

Open-source backend-as-a-service: accounts, databases, files, serverless functions, teams, and avatars. 95 endpoints across the combined client and server surface.

Quickstart

Get started with Appwrite in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"create an Appwrite user account"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Appwrite API.

Manage user accounts including email, password, sessions, and recovery via /account

Read, create, update, and delete documents in collections through /database/collections/{collectionId}/documents

Upload, download, and manage files in storage buckets via /storage/files

Invoke and manage serverless functions and their executions through /functions

GET STARTED

Start building with Appwrite API

Explore with Jentic

View OpenAPI Document

Use for: I want to create a user account with an email and password, Upload a profile image to an Appwrite storage bucket, Create a document in the 'orders' collection, Invoke an Appwrite cloud function and read its execution result

Not supported: Does not handle payment processing, send transactional email, or run a managed CDN — use for backend account, database, storage, function, and team operations on Appwrite only.

Jentic publishes the only available OpenAPI document for Appwrite, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Appwrite, keeping it validated and agent-ready. Appwrite is an open-source backend-as-a-service that exposes REST APIs for accounts, authentication, document databases, file storage, serverless functions, teams, locale data, and gravatar-style avatars. This combined spec covers 95 operations spanning 65 paths across the full account, database, storage, functions, teams, users, projects, and health surfaces. It is the union of the client-side and server-side Appwrite APIs.

Use Cases

Patterns agents use Appwrite API for, with concrete tasks.

★ Mobile App Backend in a Box

A mobile team uses Appwrite as the backend for a new iOS or Android app — sign-up and login through /account, persistent state in /database collections, user-uploaded files in /storage buckets, and notifications dispatched from /functions. The single Appwrite project replaces a custom Node.js + Postgres + S3 stack and ships in days rather than weeks.

POST /account with email and password to create a user, then POST /database/collections/{collectionId}/documents to write the user's first profile record

Self-Hosted Document Storage

Teams that cannot send data to managed cloud providers self-host Appwrite and use the database and storage APIs as a private document and file backend. Documents are stored in collections with role-based read/write rules, and files are uploaded to buckets with similar access control. The /health endpoints expose readiness checks for self-hosted deployments.

Upload a PDF to a storage bucket via POST /storage/files, then create a document in /database/collections/{collectionId}/documents referencing the file id

Serverless Function Orchestration

An automation pipeline triggers Appwrite serverless functions to run business logic — image resizing, webhook fan-out, scheduled reports — without provisioning containers. The /functions API creates functions, manages versions, executes them with payloads, and reads execution logs and status, giving the same control plane as AWS Lambda but tied to the Appwrite project.

POST /functions/{functionId}/executions with a JSON payload, then poll the execution id for status and stdout

AI Agent Backend Integration

An AI agent uses Jentic to call Appwrite as the backend for an agent-built application — provisioning user accounts, persisting documents, uploading files, and invoking functions. Because Appwrite is open source and Jentic-maintains the only structured spec, agents have a stable, validated tool surface even as Appwrite versions evolve.

Search Jentic for 'create appwrite user', call POST /account, then POST /database/collections/{collectionId}/documents to seed the user's profile

Key Endpoints

95 endpoints — jentic publishes the only available openapi specification for appwrite, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/account

Create a new user account

POST

/account/sessions

Create a new session by email and password

POST

/storage/files

Upload a file to a storage bucket

POST

/teams

Create a team

GET

/users

List users (server-side)

GET

/avatars/initials

Generate an avatar from a user's initials

GET

/locale/countries

List supported countries

POST

/account

Create a new user account

POST

/account/sessions

Create a new session by email and password

POST

/storage/files

Upload a file to a storage bucket

POST

/teams

Create a team

GET

/users

List users (server-side)

GET

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Appwrite uses a project header plus either a session cookie (client) or an API key (server). Jentic vaults both and injects them into the X-Appwrite-Project and X-Appwrite-Key headers at execution time, so the agent never reads the raw values.

Intent-based discovery

Agents search Jentic by intent ('create user', 'upload file', 'invoke function') and Jentic returns the matching Appwrite operation with parameters and response schema, removing the need to navigate the docs site.

Time to first call

Direct integration: 1-2 days to wire auth, header conventions, and document/storage permissions. Through Jentic: under 1 hour — search, load, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Supabase API

Open-source Firebase alternative with a Postgres-backed database and similar auth/storage/functions surface

Pick Supabase when SQL/Postgres is the team's preferred database; pick Appwrite for a NoSQL document model and tighter file/avatar primitives.

Alternative

Firebase API

Google's hosted backend-as-a-service with a similar account, database, and storage surface

Pick Firebase when targeting Google Cloud and needing real-time sync; pick Appwrite for self-hosting or open-source licensing.

Complementary

Appwrite Server API

Server-side surface of the same Appwrite API with admin operations

Use the server slug when the agent needs admin keys to manage users or write across all collections; use this combined surface for general access.

FAQs

Specific to using Appwrite API through Jentic.

Why is there no official OpenAPI spec for Appwrite?

Appwrite does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Appwrite via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Appwrite API use?

Appwrite supports two patterns: client-side requests authenticate with the X-Appwrite-Project header and a session cookie obtained through /account/sessions, while server-side requests use an API key in the X-Appwrite-Key header alongside the project header. Through Jentic both flows are vaulted and the agent only sees scoped credentials at execution time.

Can I store files with the Appwrite API?

Yes. POST /storage/files uploads a file to a bucket, GET /storage/files/{fileId} reads metadata, GET /storage/files/{fileId}/view streams the binary, and DELETE /storage/files/{fileId} removes it. Per-bucket access rules govern who can read and write.

What are the rate limits for the Appwrite API?

Self-hosted Appwrite has no enforced rate limit beyond your server's capacity. Appwrite Cloud applies plan-based quotas — Free, Pro, and Scale — covering bandwidth, storage, executions, and database operations. Check the Appwrite Cloud pricing page for the exact ceilings on your plan.

How do I create a user account through Jentic?

Run pip install jentic, search 'create appwrite user', load POST /account, and execute it with email, password, and optional name. Jentic injects the X-Appwrite-Project (and X-Appwrite-Key for server flows) from the vault and returns the new user document.

Is Appwrite free?

Self-hosted Appwrite is fully open source under the BSD-3-Clause license and free to run on your own infrastructure. Appwrite Cloud has a free tier suitable for hobby projects plus paid Pro and Scale tiers for production workloads.