Documentation

API Reference

Complete REST API documentation for the Agentidoo Agent Protocol v1 (AAP v1). All API endpoints require authentication and are served from the API subdomain.

Base URL https://api.agentidoo.com/api/v1

Authentication

All /api/v1/* endpoints require a Bearer token in the Authorization header. Tokens are issued via OIDC login through the dashboard, or you can use an API key generated from your account settings.

AUTH Authorization: Bearer <token> Required on all /api/v1/* endpoints

Identity & Capabilities

Retrieve and update the authenticated user's profile and workspace information.

GET /me Get current user profile & workspace Auth Required
PUT /me Update user profile settings Auth Required
GET /capabilities List available agent capabilities for this workspace Auth Required

Chat Sessions

Create and manage AI chat sessions. Each session maintains its own conversation history and can stream real-time responses via Server-Sent Events (SSE).

POST /chat/sessions Create a new chat session Auth Required
GET /chat/sessions List all sessions for the current user Auth Required
GET /chat/sessions/{id} Get session details and messages Auth Required
DEL /chat/sessions/{id} Archive a session Auth Required
POST /chat/sessions/{id}/messages Send a message to the agent Auth Required
GET /chat/sessions/{id}/stream Stream agent responses (SSE) Auth Required
POST /chat/sessions/{id}/interrupt Interrupt a running agent response Auth Required
POST /chat/sessions/{id}/register_tools Register custom tools for a session Auth Required

Odoo Connection

Configure and test the connection between Agentidoo and your Odoo instance.

GET /odoo Get current Odoo connection config Auth Required
POST /odoo Save Odoo connection credentials Auth Required
POST /odoo/test Test connectivity to the configured Odoo instance Auth Required
GET /odoo/modules List installed Odoo modules Auth Required

Tool Validation

Server-side validation for agent-proposed actions. Before the agent executes a frontend action or renders an owlet widget, it submits the payload here for schema and permission validation.

POST /tools/odoo_frontend_action/validate Validate an Odoo frontend action payload Auth Required
POST /tools/owlet/validate Validate an owlet widget payload Auth Required

Automations

Schedule and manage recurring agent jobs. Automations run on a cron schedule or can be triggered manually.

GET /automations List all automations Auth Required
POST /automations Create a new automation Auth Required
GET /automations/{id} Get automation details Auth Required
PUT /automations/{id} Update an automation Auth Required
DEL /automations/{id} Delete an automation Auth Required
POST /automations/{id}/run Trigger an automation run immediately Auth Required

Billing

Manage subscription, credits, and payment methods via Stripe integration.

GET /billing Get current plan, balance, and usage Auth Required
POST /billing/checkout Create a Stripe checkout session Auth Required
GET /billing/transactions List billing transactions Auth Required
PUT /billing/overage Configure overage settings Auth Required

API Keys

Manage API keys for programmatic access to the Agentidoo API.

GET /keys List all API keys Auth Required
POST /keys Create a new API key Auth Required
DEL /keys/{id} Revoke an API key Auth Required

Webhooks

Inbound webhook endpoints (no authentication required).

POST /webhooks/stripe Stripe payment event webhook Public

Getting Started

Try Aimee with sample data first, or install the free module on your own Odoo instance. The Free service plan includes 25 credits per month with no credit card required.

Try the live demo Create a free account

In the demo, choose Sign in with demo. It uses shared sample data and resets daily.

Odoo Module Installation

Agentidoo is a free native module for Odoo. Start with the Odoo 19 Community or Enterprise version linked below. Choose the matching version in Odoo Apps if your instance runs another release. Installation requires an administrator and a host that permits custom Python addons, such as Odoo.sh or a self-hosted server. Standard Odoo Online does not support this installation method.

  1. Get the free Agentidoo module from Odoo Apps, including its listed dependencies.
  2. On Odoo.sh, use the app listing’s deployment option or add the addons to your project repository. On a self-hosted server, add them to your configured addons path and restart Odoo.
  3. In Odoo, enable developer mode, update the Apps list, search for Agentidoo and install it. Use a backup or test instance for the first installation.
  4. Open Aimee in Odoo and follow Connect Aimee to sign in or create your free Agentidoo account. Complete the connection in the Odoo interface.
  5. Start with a read request such as “Show my recent quotations.” Aimee works with the permissions of the connected Odoo user.

The free module and the Free service plan are separate: the plan includes a monthly credit allowance, not unlimited AI usage. If your host blocks custom addons, try the demo or contact support to discuss an appropriate setup.

Need Help?

Our support team is available to help with installation, configuration, and API integration.

Contact Support