Skip to main content
You can create API keys that allow external applications to send HTTP requests directly to your agent — exposing the agent as a service.

​
Enabling API access

1

Go to Agent Settings

Open the agent you want to expose and navigate to Settings → API access.
2

Enable API access

Toggle Allow API agent access to on.
3

Create an API key

Click Create key to generate an access key for this agent.
4

Instruct your agent

Tell your agent what to do when it receives an HTTP request, otherwise it will ignore them.

​
Making requests

Once enabled, your agent can accept HTTP requests at its endpoint: 
https://service.abundly.ai/agent/{agent_id}/*
Include your API key as an HTTP header: 
curl -X POST https://service.abundly.ai/agent/{agent_id}/test \
  -H "X-Agent-Access-Key: your_access_key_here" \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello!"}'
Enterprise customers on a dedicated deployment will have a different base URL. Replace service.abundly.ai with your organization’s service URL, which is shown in your Abundly workspace settings or available from support.
Keep your API keys secure. Never expose them in client-side code or public repositories.

​
Need help?

Contact Support

Questions about API access? Contact our team.