API Overview
Build custom integrations with the tahc REST API.
The tahc API is coming soon! We're building a powerful REST API that will let you create custom integrations and automate workflows.
What's Coming
The tahc API will enable you to build custom integrations, automate workflows, and extend tahc's functionality.
Planned Capabilities
- Read conversations and messages
- Send messages programmatically
- Manage contacts and their data
- Receive webhooks for real-time events
- Access analytics data
- Configure settings via API
API Features
When the API launches, you'll have access to:
- RESTful endpoints with JSON responses
- Bearer token authentication
- Comprehensive webhook events
- Rate limiting with clear headers
- Full documentation with code examples
Example Preview
Here's a preview of what API requests will look like:
Example request
curl -X GET "https://app.tahc.ai/api/v1/conversations" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Example response
{
"data": [
{
"id": "conv_123",
"visitor_email": "[email protected]",
"status": "open",
"created_at": "2025-01-15T14:30:00Z"
}
],
"meta": {
"total": 42,
"page": 1,
"per_page": 20
}
}Planned Endpoints
Conversations
| Method | Endpoint | Description |
|---|---|---|
| GET | /conversations | List all conversations |
| GET | /conversations/:id | Get single conversation |
| POST | /conversations/:id/messages | Send a message |
| PATCH | /conversations/:id | Update conversation |
Contacts
| Method | Endpoint | Description |
|---|---|---|
| GET | /contacts | List all contacts |
| GET | /contacts/:id | Get single contact |
| POST | /contacts | Create contact |
| PATCH | /contacts/:id | Update contact |
| DELETE | /contacts/:id | Delete contact |
Knowledge Base
| Method | Endpoint | Description |
|---|---|---|
| GET | /knowledge | List articles |
| POST | /knowledge | Add article |
| DELETE | /knowledge/:id | Remove article |
Analytics
| Method | Endpoint | Description |
|---|---|---|
| GET | /analytics/overview | Dashboard metrics |
| GET | /analytics/conversations | Conversation stats |
Webhooks (Planned)
Receive real-time notifications for events:
| Event | Description |
|---|---|
conversation.created | New conversation started |
conversation.escalated | AI escalated to human |
conversation.closed | Conversation ended |
message.received | New message from visitor |
contact.created | New contact added |
Get Notified
Want to know when the API is available?
- Follow us on social media for updates
- Check back on this page
- Contact [email protected] to join the beta list
Available Now
While the API is in development, you can use these integrations today:
- Slack Integration — Real-time notifications
- Email Notifications — Get alerted for escalations
Next Steps
- Set up Slack integration for real-time alerts
- Configure email notifications
Was this helpful?