Appwrite

Name: Appwrite API
Brand: Appwrite
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsCi CdapiKey61 EndpointsREST

For Agents

Client-side Appwrite surface for end-user flows: account, sessions, OAuth, JWTs, documents, files, teams, avatars. 61 endpoints authenticated by user session.

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:
"sign in an Appwrite user with email and password"

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

Capabilities

What an agent can do with Appwrite API.

Issue and verify JWTs for the current user via /account/jwt

Read and write documents subject to per-collection user permissions

Upload and download files in buckets where the user has read/write rights

GET STARTED

Start building with Appwrite API

Explore with Jentic

View OpenAPI Document

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. This is the client-side surface of the Appwrite open-source backend-as-a-service — 61 operations across 41 paths covering end-user account flows, OAuth2 sessions, anonymous sessions, JWT tokens, document reads and writes, file storage, team membership, and avatar generation. It is intended for code that runs in the user's browser or device, where calls are authenticated by the user's session, not an admin key.

Use Cases

Patterns agents use Appwrite API for, with concrete tasks.

★ Mobile/SPA Authentication

A single-page web app or mobile client uses the Appwrite client API for end-user auth — POST /account/sessions for email login, POST /account/sessions/oauth2/{provider} for Google or GitHub login, POST /account/sessions/anonymous for guest access, and POST /account/jwt to mint short-lived JWTs that downstream services can verify. The session cookie carries the authenticated user identity for subsequent calls.

POST /account/sessions/oauth2/google with success and failure redirects, then on return call POST /account/jwt to issue a JWT

User-Owned Document Workspace

A note-taking or productivity app stores per-user documents in Appwrite collections with row-level read/write rules tied to the user id. The client surface lets the user list, create, update, and delete only the documents they own, while shared documents become accessible via team membership rules. No server-side admin key is required client-side.

POST /database/collections/{collectionId}/documents with permissions ['user:CURRENT_USER_ID'] and the note body

Direct File Upload from Browser

A file-sharing UI lets users upload directly from the browser to Appwrite storage, bypassing the application server. POST /storage/files accepts the file with a session cookie and bucket-level permissions; downloads stream from GET /storage/files/{fileId}/download. This pattern reduces backend bandwidth costs and shortens upload time for large files.

POST /storage/files with a file object and the user's session cookie, then call GET /storage/files/{fileId}/preview for a thumbnail

AI Agent Acting On Behalf Of A User

An AI agent that has been delegated user credentials uses Jentic to operate on the user's Appwrite data — reading their documents, uploading files, joining teams. Because this is the client surface, the agent works with a session JWT scoped to one user, not an admin key, which keeps the blast radius contained.

Search Jentic for 'list user's documents in appwrite', call GET /database/collections/{collectionId}/documents with the user's session JWT, and return documents the user owns

Key Endpoints

61 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

/account/jwt

Issue a JWT for the current user

GET

/account/sessions/oauth2/{provider}

Start an OAuth2 flow with a provider

POST

/storage/files

Upload a file to a storage bucket

GET

/avatars/initials

Generate an avatar from a user's initials

POST

/account

Create a new user account

POST

/account/sessions

Create a new session by email and password

POST

/account/jwt

Issue a JWT for the current user

GET

/account/sessions/oauth2/{provider}

Start an OAuth2 flow with a provider

POST

/storage/files

Upload a file to a storage bucket

Why though Jentic?

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

Credential isolation

The client surface uses a Project header plus a per-user JWT or session cookie. Jentic vaults both, scoping the JWT to the requesting user, so the agent operates within that single user's permissions and never holds an admin key.

Intent-based discovery

Agents search Jentic by intent ('sign in user with google', 'upload file as user') and Jentic returns the matching client-surface Appwrite operation with parameters and response schema.

Time to first call

Direct integration: 1-2 days to wire OAuth flows, JWT minting, and bucket permissions. Through Jentic: under 1 hour — search, load, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Appwrite Server API

Admin-key surface that complements the user-session client surface

Use the server slug when the agent needs an admin key to act across all users; use this client slug when acting as one specific user.

Alternative

Supabase API

Postgres-backed open-source backend with a similar client/server split

Pick Supabase when SQL is the preferred database model; pick Appwrite Client for NoSQL documents with bucket-style file storage.

Alternative

Firebase API

Google's BaaS with a similar client SDK pattern for auth, database, and storage

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

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 Client API use?

It uses two headers: Project (the Appwrite project id) and JWT (a short-lived JWT minted via POST /account/jwt or a session cookie set after /account/sessions). Server-side admin keys are NOT valid here — this surface is for end-user contexts only. Through Jentic the project id and JWT are vaulted and attached at execution.

Can I sign in with Google or GitHub through the Client API?

Yes. POST /account/sessions/oauth2/{provider} starts an OAuth2 redirect with the chosen provider (google, github, facebook, apple, and others supported by Appwrite). After the user returns, the session is established and you can call POST /account/jwt to mint a JWT for downstream calls.

What are the rate limits for the Appwrite Client API?

Self-hosted Appwrite has no enforced rate limit beyond your server's capacity. Appwrite Cloud applies plan-based quotas covering bandwidth, storage, function executions, and database operations. Sessions endpoints carry tighter per-IP brute-force protection regardless of plan.

How do I issue a JWT for the current user through Jentic?

Run pip install jentic, search 'issue appwrite jwt', load POST /account/jwt, and execute it with the active session cookie or token. Jentic returns the signed JWT, which the agent can pass to downstream services that verify Appwrite-issued tokens.

Is the Appwrite Client API free?

Self-hosted Appwrite is open source under BSD-3-Clause and free. Appwrite Cloud has a free tier for hobby projects plus paid Pro and Scale tiers; the same client API is available on every plan.