Skip to main content
The Wassist REST API provides programmatic access to all platform features. Build integrations, automate workflows, and manage your WhatsApp agents at scale.

​
Base URL

All API requests should be made to: 
https://backend.wassist.app/api/v1/

​
Authentication

The Wassist API uses API key authentication. Include your API key in the X-API-Key header of every request: 
X-API-Key: your-api-key-here

​
Getting Your API Token

  1. Log in to wassist.app
  2. Navigate to Settings → API Keys
  3. Click Create API Key
  4. Copy and securely store your token
Keep your API token secret. Never expose it in client-side code or commit it to version control.

​
Example Request

curl -X GET https://backend.wassist.app/api/v1/agents/ \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json"

​
Request Format

  • All request bodies should be JSON
  • Set Content-Type: application/json header
  • For file uploads, use multipart/form-data
curl -X POST https://backend.wassist.app/api/v1/agents/ \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"name": "My New Agent"}'

​
Response Format

All responses are JSON. Successful responses include the requested data: 
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Agent",
  "description": "A helpful assistant",
  ...
}

​
Paginated Responses

List endpoints return paginated results: 
{
  "count": 42,
  "next": "https://backend.wassist.app/api/v1/agents/?offset=20",
  "previous": null,
  "results": [
    { "id": "...", "name": "Agent 1" },
    { "id": "...", "name": "Agent 2" }
  ]
}
Use offset and limit query parameters to paginate: 
GET /agents/?offset=20&limit=20

​
Error Responses

Errors return appropriate HTTP status codes with a JSON body: 
{
  "error": "Agent not found",
  "code": "not_found"
}

​
Common Status Codes

CodeDescription
200Success
201Created
204No Content (successful delete)
400Bad Request (validation error)
401Unauthorized (invalid/missing token)
403Forbidden (insufficient permissions)
404Not Found
429Rate Limited
500Server Error

​
Rate Limiting

API requests are rate-limited to ensure fair usage. Current limits:
  • 100 requests per minute per API token
When rate limited, you’ll receive a 429 response: 
{
  "error": "Rate limit exceeded",
  "retry_after": 60
}

​
API Resources

Agents

Create and manage AI agents with all their configurations.

WhatsApp Accounts

Connect and manage WhatsApp Business accounts.

WhatsApp Linking

Create link sessions for connecting new accounts.

Business API Proxy

Access the WhatsApp Business API directly.

​
Quick Reference

​
Agents

MethodEndpointDescription
GET/agents/List all agents
POST/agents/Create an agent
GET/agents/{id}/Get an agent
PUT/agents/{id}/Update an agent
DELETE/agents/{id}/Delete an agent
POST/agents/{id}/deploy/Deploy to WhatsApp
POST/agents/{id}/share/Share with a user

​
WhatsApp Accounts

MethodEndpointDescription
GET/whatsapp-accounts/List accounts
GET/whatsapp-accounts/{id}/Get an account
POST/whatsapp-accounts/{id}/deploy-agent/Deploy agent
POST/whatsapp-accounts/{id}/add-number/Add phone number
*/whatsapp-accounts/{id}/proxy/{path}Business API proxy

​
WhatsApp Linking

MethodEndpointDescription
POST/whatsapp-link-sessions/Create link session
GET/whatsapp-link-sessions/List sessions
GET/whatsapp-link-sessions/{id}/Get session

​
Support

Need help with the API?

Contact Support

Reach out to our team.