API Reference

Authentication

All API requests require an API key passed in the Authorization header. You can generate API keys from your dashboard under Settings → API Keys.

curl -X GET https://api.upgpt.ai/v1/agents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

API keys are scoped to your workspace and carry the same permissions as the user who created them. Treat your API key like a password -- do not expose it in client-side code.

Base URL

All API endpoints are available at:

https://api.upgpt.ai/v1/

Endpoints Overview

Agents

Leads & Contacts

Bookings

Webhooks

Rate Limits

API requests are rate-limited per workspace to ensure platform stability:

Rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) are included in every response. When a limit is exceeded, the API returns 429 Too Many Requests.

Webhooks

UpGPT can send real-time event notifications to your endpoints via webhooks. Supported events include:

• booking.created -- A new booking has been scheduled
• booking.cancelled -- A booking has been cancelled
• lead.qualified -- A lead has been qualified by an AI agent
• lead.routed -- A lead has been routed to a representative
• agent.escalation -- An agent has escalated a conversation
• payment.received -- A payment has been processed

Webhook payloads are signed with HMAC-SHA256 using your webhook secret. Always verify signatures before processing events in production.

SDKs

Official SDKs are available for popular languages. Each SDK wraps the REST API and handles authentication, retries, and error handling automatically.

Error Handling

The API returns standard HTTP status codes and a consistent JSON error body:

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key provided is invalid or has been revoked.",
    "status": 401
  }
}