Appwrite

Name: Appwrite API
Brand: Appwrite
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsCi CdapiKey61 EndpointsREST

Install Jentic One Beta

Connect the Appwrite to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Appwrite, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fappwrite.io%2Fclient" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fappwrite.io%2Fclient" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

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

GET STARTED

Start building with Appwrite API

Explore with Jentic One

View OpenAPI Document

For Agents

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

Use for: I want to sign in a user with email and password, Authenticate a user with the Google OAuth2 provider, Issue a JWT for the currently logged-in user, Upload an image file to a storage bucket as the current user

Not supported: Does not expose admin operations such as creating users without sign-up or writing as another user - use the Appwrite Server API for those; this client API is session-scoped only.

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 Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the Appwrite client surface by hand means managing the X-Appwrite-Project header plus a per-user JWT or session cookie, and following the account and session flows yourself. Through Jentic you install once, import the Appwrite Client API from the API Directory, store the credentials once, and your agent calls it.

Permission scoping

The client surface scopes the JWT to the requesting user and takes its targets in the request body, so you limit the agent to the operations it needs, such as signing in a user or uploading a file as that user. You choose the operations it may call, and the agent operates within that single user's permissions rather than holding an admin key.

Credential isolation

Your Appwrite project header and per-user JWT or session cookie are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'sign in a user with Google' or 'upload a file as a user', and Jentic returns the matching client-surface Appwrite operation with its parameters and response schema so the agent calls the right endpoint without navigating the docs site.

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 with Jentic One, the self-hosted execution layer.

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.

Can I limit what my agent is allowed to do with the Appwrite Client API?

Yes. Jentic One is self-hosted by you, so your own rules decide which client operations the agent may call and which credentials it may use. Because this is the client surface, the JWT is scoped to a single requesting user rather than an admin key, so you can restrict the agent to just the operations it needs, such as signing in a user with POST /account/sessions or uploading a file with POST /storage/files. The agent then acts only within that one user's permissions, and any operation you do not grant stays off limits.

Appwrite

Connect the Appwrite to your agent

Capabilities

Start building with Appwrite API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs