Meer Ashikul Islam
Admin
Developer API & Webhooks
Integrate ShinobiFlow agents directly into your apps using REST endpoints and real-time event webhooks.
API Quickstart
Trigger agent execution via HTTP POST
curl -X POST https://api.shinobiflow.io/v1/agents/run \
-H "Authorization: Bearer sk_live_51NpX9AbX..." \
-H "Content-Type: application/json" \
-d '{
"agent_id": "agent_scraper_v2",
"input": "https://example.com/target-data",
"async": true
'}'
import requests
# Trigger ShinobiFlow AI Agent
response = requests.post(
"https://api.shinobiflow.io/v1/agents/run",
headers={"Authorization": "Bearer sk_live_..."},
json={"agent_id": "agent_scraper_v2", "async": True}
)
print(response.json())
const fetch = require('node-fetch');
// Trigger ShinobiFlow AI Agent
const res = await fetch('https://api.shinobiflow.io/v1/agents/run', {
method: 'POST',
headers: { 'Authorization': 'Bearer sk_live_...' },
body: JSON.stringify({ agent_id: 'agent_scraper_v2' })
});
console.log(await res.json());
API Health & Rate Limits
Available REST Endpoints
A comprehensive list of functional API endpoints for core interactions.
/v1/agents
Retrieve a list of all configured AI agents.
/v1/agents/run
Trigger an asynchronous agent workflow.
/v1/agents/{id}/config
Update specific agent parameters dynamically.
/v1/analytics/usage
Fetch token usage and billing statistics.
/v1/webhooks/{id}
Remove an active webhook listener.
Configured Webhook Endpoints
Receive real-time event payloads whenever agent statuses or workflows change.
| Endpoint URL | Subscribed Events | Status | Signing Secret | Actions |
|---|---|---|---|---|
| https://api.yourcompany.com/webhooks/agent-complete | agent.completed | Active | whsec_892X...kL910 | |
| https://discord.com/api/webhooks/129849102/alerts | agent.failed | Active | whsec_110K...pP921 | |
| https://hooks.slack.com/services/T00000000/B00000000 | agent.failed billing.limit | Paused | whsec_slack...kP22 | |
| https://crm.hubspot.com/api/webhooks/incoming | lead.generated | Active | whsec_hub...zX19 | |
| https://mail.sendgrid.com/v3/events | report.ready | Active | whsec_snd...yT88 |