Frappe
Use Frappe when an agent needs to search, read, create, update or delete DocType records, inspect document schemas, upload private attachments, or invoke approved whitelisted business methods on a user-connected Frappe Framework, ERPNext or Frappe CRM server. Use metadata before constructing custom CRM records; paginate searches; use application business methods for workflow transitions rather than bypassing approvals with generic updates. Requires a public HTTPS site root and the user’s API key:API secret in Vault; all actions run with that Frappe user’s permissions. Choose a narrower application integration for role-specific projections. Ask before writes, deletions, uploads and consequential method calls; never use Administrator credentials for clients. Serialize writes and dependent reads on the same document: await each result before the next call. After a timeout, read the committed state before retrying; never blindly repeat a create or consequential method.
Category
Pricing and payment
- Pricing
- Free in Loadout. Provider charges may apply when using a personally connected account.
- Unified payment
- Not currently supported. Connect a provider account when required.
Use Frappe with AI agents
Aident Loadout lets Claude Code, Codex, Cursor, and other supported agents call Frappe. Choose from 9 supported Actions. Review each execution in Audit. Connect Frappe once through Aident Vault. Your agent can use the supported Actions without receiving the underlying credential.
Included Actions
- Call MethodInvoke an explicitly approved whitelisted dotted Python business method with JSON arguments in body. May commit writes or trigger external effects; inspect the application contract and obtain confirmation first. No arbitrary code execution; server whitelist and permissions still…
- Create DocumentCreate one DocType record with custom fields in body. Inspect metadata and ask before creating. Frappe permissions and validation apply.
- Delete DocumentDelete an exact document only after explicit confirmation of DocType and name. Deletion can be irreversible and may fail on linked records.
- Get Doctype MetadataInspect DocType field definitions and relationships using the native v2 metadata endpoint (Frappe v15+). Server permission checks apply; this is not a permission grant.
- Get DocumentRead one permitted document by exact DocType and name, including child-table fields.
- Get Logged UserCheck the authenticated Frappe user before accessing private CRM data.
- List DocumentsSearch and paginate permission-filtered DocType records. fields, filters and or_filters are JSON-encoded strings; filter operators include = and like. Never infer unrestricted access from an empty result.
- Update DocumentUpdate only intended fields in body. Read current record first; preserve unrelated fields. Do not bypass workflow approvals or use direct SQL.
- Upload FileUpload a private attachment from an authorized short-lived HTTPS file URL; do not send a local filesystem path. Attach to an authorized DocType/name. File access and document permissions must be enforced by the target application.
Related use cases
No verified related use cases are linked yet.