Agent-ready OpenAPI document · curated by JenticDeveloper ToolsCi CdapiKey95 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Server-side Appwrite surface authenticated by an admin API key: full /users administration, /projects configuration, /functions, /database, /storage. 95 endpoints.
Use for: I want to create a user account programmatically as an admin, Delete a user and all of their sessions, Configure a new OAuth2 provider on an Appwrite project, Deploy a new version of a cloud function with a tag
Not supported: Does not run on the client side or accept user session JWTs - use the Appwrite Client API for user-context calls; this server API requires an admin key only.
Jentic publishes the only available OpenAPI specification for Appwrite, keeping it validated and agent-ready. This is the server-side surface of the Appwrite open-source backend-as-a-service - 95 operations across 65 paths exercised with an admin API key. It includes admin operations on /users, project-level configuration under /projects, server-side function management at /functions, and full read/write access to /database and /storage that bypasses per-user permission rules. Use this from trusted server code, never from the browser or a mobile client.
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.
1
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%2Fserver" | sh2
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%2Fserver" | sh
jentic register # connects your agent to your Jentic One instanceJentic 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.
Create, list, update, and delete user accounts admin-side via /users
Configure projects, OAuth providers, and webhooks via /projects
Read and write any document in any collection regardless of per-user rules
Upload, read, and delete files in any storage bucket regardless of bucket permissions
Manage cloud functions including code deployment, tags, and execution at scale
Read /health endpoints to monitor self-hosted Appwrite deployment status
Administer team rosters and role assignments without acting as a member
Use Cases
Patterns agents use Appwrite API for, with concrete tasks.
★ Backend-Side User Administration
An internal admin tool uses the Appwrite Server API to create test users, reset passwords for support cases, suspend abusive accounts, and bulk-import users from a CSV. Server-key calls bypass user session requirements, so the tool can act on any account. The /users endpoint group covers create, list, update, delete, and session revocation operations.
POST /users with an email, password, and name to create a new user, then DELETE /users/{userId}/sessions to invalidate any existing sessions
CI Function Deployment
A CI pipeline deploys new versions of Appwrite cloud functions on every merge to main. The Server API exposes /functions for create and update, /functions/{functionId}/tags for code uploads, and /functions/{functionId}/executions for smoke tests. The full deploy-and-verify cycle runs from a CI job using only the project's admin key.
POST /functions/{functionId}/tags with the new function code, then POST /functions/{functionId}/executions to verify it runs
Project Configuration as Code
Teams keep their Appwrite project configuration - OAuth providers, webhooks, platform allowlists, JWT settings - under version control and apply changes through the /projects API. This makes project setup reproducible across staging and production without clicking through the Appwrite console for each environment.
POST /projects/{projectId}/webhooks with name, URL, and events list including database.documents.create
AI Agent Server-Side Automation
An AI agent with delegated server-key access uses Jentic to perform administrative work - provisioning users for a new tenant, deploying function code, writing audit logs into a privileged collection. Because the server API key has full access, Jentic's vault isolation is critical: the key stays in your Jentic One instance and the agent only sees scoped credentials at execution time.
Search Jentic for 'create appwrite user as admin', call POST /users, then POST /teams/{teamId}/memberships to add the user to the tenant team
Key Endpoints
95 endpoints — jentic publishes the only available openapi specification for appwrite, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/users
Create a new user account admin-side
GET
/users
List all users in the project
POST
/projects/{projectId}/webhooks
Configure a webhook on a project
POST
/functions/{functionId}/tags
Upload a new code tag for a function
POST
/functions/{functionId}/executions
Execute a function with a payload
POST
/storage/files
Upload a file to any storage bucket
GET
/health
Read the overall health status of the Appwrite instance
POST
/users
Create a new user account admin-side
GET
/users
List all users in the project
POST
/projects/{projectId}/webhooks
Configure a webhook on a project
POST
/functions/{functionId}/tags
Upload a new code tag for a function
POST
/functions/{functionId}/executions
Execute a function with a payload
POST
/storage/files
Upload a file to any storage bucket
GET
/health
Read the overall health status of the Appwrite instance
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
A
Appwrite
- Non-Ready (C)54/100
38
Foundational Compliance32
Developer Experience & Jentic Compatibility57
AI-Readiness & Agent Experience86
Agent Usability100
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
38
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: FSignals: 4
52%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
0%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
32
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: FSignals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
28%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
0%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
57
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: C+Signals: 4
69%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
59%
Summary Coverage
Coverage of summaries across operations/tags/info.
86
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: ASignals: 1
86%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
100
Security
Trust, risk posture, and security compliance.
Grade: A+Signals: 1
100%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Appwrite server surface by hand means managing the X-Appwrite-Project header plus the scoped admin API key, and mapping its user, project, function, and storage operations yourself. Through Jentic you install once, import the Appwrite Server API from the API Directory, store the admin key once, and your agent calls it.
Permission scoping
The server surface puts project and function ids in the URL path (/projects/{projectId}/webhooks, /functions/{functionId}/executions), so a rule can pin your agent to one project or function. You choose the operations it may call, so user creation or webhook writes are not included unless you add them, which keeps the admin key's reach narrow.
Credential isolation
Your Appwrite admin key is stored once, encrypted, by your own Jentic One instance and attached at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create an Appwrite user' or 'deploy an Appwrite function', and Jentic returns the matching server-surface operation with its parameters and response schema so the agent calls the right endpoint without scrolling the docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
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 Server API use?
It uses two headers: X-Appwrite-Project (the project id) and X-Appwrite-Key (a server API key generated from the Appwrite console with explicit scopes). The key bypasses per-user rules, so it must never be exposed to client-side code. Through Jentic the key stays vaulted and is attached at execution time only.
Can I create users without a sign-up flow?
Yes. POST /users creates a user record directly with email, password, and optional name; the user can log in afterward via the client surface. This is the standard pattern for migrating users from another auth system or pre-creating accounts for invited tenants.
What are the rate limits for the Appwrite Server API?
Self-hosted Appwrite is bounded by your server's capacity. Appwrite Cloud applies plan-based quotas covering bandwidth, storage, function executions, and database operations. Server-key calls share the project quota with client-key calls; there is no separate admin allowance.
How do I deploy a new function tag through Jentic?
Run pip install jentic, search 'deploy appwrite function', and load POST /functions/{functionId}/tags. Execute it with the function id, command, and code archive. Jentic injects the X-Appwrite-Key from the vault and returns the new tag id.
Is the Appwrite Server API free?
Self-hosted Appwrite is fully open source under BSD-3-Clause and free. Appwrite Cloud has a free tier for hobby projects plus Pro and Scale paid plans for production usage; the server API is included on every plan.
Can I limit what my agent is allowed to do with the Appwrite Server API?
Yes. Because you run Jentic One yourself, your own rules decide which Appwrite operations the agent may call, so you can allow reads while withholding admin actions like user creation (POST /users) or webhook writes (POST /projects/{projectId}/webhooks) unless you explicitly add them. Since project and function ids live in the URL path, such as /projects/{projectId}/webhooks and /functions/{functionId}/executions, a rule can pin the agent to a single project or function. This keeps the admin key's reach narrow even though the key itself carries full access.
GET STARTED