Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abundly.ai/llms.txt

Use this file to discover all available pages before exploring further.

Your agent can be called from outside Abundly. In the agent’s Settings → API Access tab, you can expose the agent as an HTTP API, as an MCP server, as a webhook receiver, and as an embeddable chat widget — each with its own configuration, but sharing the same API keys.
API Access settings tab showing collapsible sections for API Keys, HTTP API, MCP Server, Chat Widget, and Webhooks

​
When to use each

Exposure modeUse forAuthentication
HTTP APICalling your agent from a script, backend service, or automation toolAPI key
MCP serverLetting AI apps like Claude Desktop, Cursor, or n8n use your agent as a tool providerAPI key
Chat widgetEmbedding an AI chat bubble on your own websiteAPI key (stored on your backend proxy)
WebhooksReceiving callbacks from external services like Stripe, GitHub, or TrelloNone (URL is the secret)
All modes run through the same agent, respect the same capabilities and guardrails, and log activity to the activity log.

​
API keys

HTTP API and MCP calls are authenticated with API keys. Open the API Keys section to create, list, and revoke keys for the agent. Include a key on every request using either header: 
X-Agent-Access-Key: your_key_here
Authorization: Bearer your_key_here
Keys grant full access to the endpoints you’ve defined. Never commit them to source control or expose them in client-side code.

​
HTTP API

Turn on Enable HTTP API to expose your agent at: 
https://your-service-domain/agents/{agentId}/api/{path}
You explicitly define which paths are available. Any request to an undefined path returns 404. For each endpoint, you choose:
  • Path — e.g. summarize or ingest/orders
  • Handler — either a natural-language prompt for the agent, or a script that runs directly without invoking the LLM
  • Model override (optional) — run this endpoint on a specific model, separate from the agent’s default
curl -X POST https://your-service-domain/agents/{agentId}/api/summarize \
  -H "X-Agent-Access-Key: your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"text": "..."}'
The JSON body is passed to the agent (or script) as input. The response contains the agent’s reply.

​
MCP server

MCP (Model Context Protocol) lets external AI applications — Claude Desktop, Cursor, n8n, and others — call tools you define on your agent. Turn on Enable MCP server to expose the agent at: 
https://your-service-domain/agents/{agentId}/mcp
For each tool you add, you specify:
  • Name and description — shown to MCP clients so they know when to call it
  • Handler — a prompt for the agent, or a script for deterministic execution
  • Model override (optional)
Connect from Claude Desktop by adding your server to the MCP config: 
{
  "mcpServers": {
    "my-agent": {
      "url": "https://your-service-domain/agents/{agentId}/mcp",
      "headers": {
        "X-Agent-Access-Key": "your_key_here"
      }
    }
  }
}

​
Chat widget

The chat widget embeds your agent as a floating chat bubble on any external website. Visitors can ask questions and get streaming answers — without logging in or leaving your site. Turn on Enable widget in the API Access tab to configure it. The widget uses a secure backend proxy pattern: a small server-side endpoint on your server holds the API key and forwards requests to Abundly, so your key never appears in client-side code. For setup instructions, backend proxy examples, configuration options, and the headless createClient API, see the Chat Widget page.

​
CORS settings

If you want to call your agent’s HTTP API directly from a browser (for example, from a web application), you need to configure which origins are allowed to make cross-origin requests. In the HTTP API section, use Allowed origins (CORS):
  • Allow requests from Abundly apps — Automatically allows requests from Abundly’s user-facing domains
  • Custom origins — Add any additional origins (e.g. https://yourapp.com) that should be permitted to make browser requests
CORS restrictions apply to browsers only. If you’re calling the API from a server-side environment, you can leave CORS unconfigured. The chat widget always goes through your backend proxy (server-to-server), so it doesn’t need a CORS entry either.

​
Webhooks

Many external services send notifications by calling a URL you provide — Stripe after a payment, GitHub when a PR opens, Trello when a card moves. Turn on Enable Webhooks to receive these callbacks. Each webhook you define gets its own URL: 
https://your-service-domain/agents/{agentId}/webhook/{integration}
Unlike HTTP API calls, webhooks have no authentication — the URL itself is the secret, since external services generally don’t support custom auth headers. Requests to undefined integration names return 404. For each integration, configure:
  • Integration name — used as the URL path, e.g. stripe or github
  • Handler — a prompt describing how the agent should process the callback, or a script for fast, deterministic handling
  • Model override (optional)
Webhooks respond immediately with 200 OK and process the payload asynchronously, so external services never time out.
Paste the webhook URL into the external service’s webhook settings. The agent will run each time the service fires an event — driven entirely by your prompt or script.

​
Activity log

All exposure modes record entries in the activity log, including the full request headers and body, the agent’s response, and any credits consumed. You can disable logging per section if you have a high-volume endpoint where logging isn’t useful.

​
Learn more

MCP Servers

Add external MCP servers to your agent’s capabilities

Code Execution

Back endpoints, tools, and webhooks with scripts for faster handling

Monitoring

Review what your agent does when triggered externally