API Reference
The AI Teammate API allows you to integrate AI agents into your applications. Use our REST API to create agents, send messages, and manage your account programmatically.
Base URL
https://ai-teammate.net/apiQuick Example
curl -X POST https://ai-teammate.net/api/agents/YOUR_AGENT_ID/chat \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"message": "Hello, how are you?"
}'API Sections
Authentication
Learn how to authenticate your API requests using API keys.
Agents
Create, manage, and configure AI agents programmatically.
Chat
Send messages to agents and receive AI-powered responses.
Teams
Create multi-agent teams and run collaborative conversations.
Webhooks
Receive AI responses from external systems via webhook tokens.
Response Format
All API responses are returned in JSON format. Successful responses include the requested data, while error responses include an error code and message.
{
"response": "Hello! I'm doing great...",
"agent_id": "abc123",
"agent_name": "My Assistant"
}{
"detail": "The API key provided is invalid."
}API Key Scopes
API keys come in three scopes. Use scoped keys for external integrations to limit access.
| Scope | Access |
|---|---|
Global | Full access to all resources |
Agent-scoped | Chat, history, memories for one agent only |
Team-scoped | Chat and history for one team only |
See Authentication for details.
Credits & Rate Limits
API usage is credit-based. New accounts receive 3,000 free credits (subject to change). Each credit covers approximately 100 tokens. BYOK (Bring Your Own Key) users bypass credit costs.
| Detail | Value |
|---|---|
| Signup bonus | 3,000 credits (may vary) |
| Credit formula | (input_tokens + output_tokens * 3) / 100 |
| Minimum per request | 1 credit |
| BYOK users | No credit cost (use your own API key) |