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

Step-by-step guide to install Agentidoo in your Odoo instance and configure your first AI agent.

Coming Soon

Odoo Module Installation

Detailed installation instructions for Odoo 17, 18, and 19 (Community and Enterprise editions).

Coming Soon

Need Help?

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

Contact Support