Operator AI | Docs
  • πŸ‘‹Welcome to Operator AI
  • Getting Started
    • πŸš€Quickstart Guide
    • πŸ”ŒConnect Your Channels
    • 🎯Go Live With Operator
    • πŸ“ˆPost-Launch Best Practices
  • Core Features
    • πŸ”„Flows Overview
    • 🧠Building Your Knowledge Base
    • βš™οΈAutomations Overview
    • πŸ•’Hours & Offline Mode
    • πŸ’¬Fallbacks & Default Replies
    • πŸ“₯Unified Inbox & Agent Handoff
  • Conversation Management
    • πŸ‘₯Users and Roles
    • 🏒Departments
    • 🏷️Tags & Organization
    • πŸ“Internal Notes
    • πŸ€–Smart Replies
  • πŸ’¬Saved Replies
  • Integrations
    • πŸ”—Zapier Integration
    • πŸ’¬Slack Integration
    • πŸ“§Email Marketing
    • πŸ“±WhatsApp Business API Setup
    • πŸ”ŒWebhooks and API
  • Best Practices
    • πŸ›€οΈDesigning Effective Flows
    • 🌱Using Automations for Growth
    • πŸ“ŠMonitoring Metrics and Optimization
    • πŸ—£οΈConversation Design Tips
  • Troubleshooting
    • πŸ› οΈCommon Connection Issues
    • πŸ”Conversation Handling Errors
    • πŸ”„Flow Troubleshooting
    • πŸ’¬Fallback Handling Problems
  • πŸ”§API & Webhook Issues
  • FAQ
    • ❓General Operator AI Questions
  • πŸ“‘Channel-specific Limitations
  • πŸ’³Billing and Pricing
  • πŸ”“Data Privacy and Security
  • API Reference
    • πŸ›‘οΈAuthentication
  • πŸ“šAvailable Endpoints
  • πŸ”—Webhooks Overview
  • 🧩Example API Requests
  • 🚫Error Codes and Handling
  • Affiliate Program
    • πŸ“’ Operator AI Affiliate Program
Powered by GitBook
On this page
  • 🚫 Common HTTP Status Codes
  • πŸ› οΈ Example Error Response Format
  • πŸ”₯ Fast Troubleshooting Tips
  • πŸ“‹ Best Practices for Error Handling
  • πŸ›Ÿ Need Help?
  • 🎯 End of API Section!

Error Codes and Handling

When something goes wrong during an API request or integration, Operator AI provides clear error codes and messages to help you diagnose and fix issues fast.


🚫 Common HTTP Status Codes

Status Code
Meaning
What to Check

200 OK

Success

Everything worked as expected.

201 Created

Success

Resource (user, message, etc.) successfully created.

400 Bad Request

Client Error

Missing fields, bad data formatting, or invalid JSON.

401 Unauthorized

Auth Error

Missing or incorrect API token β€” check Authorization header.

403 Forbidden

Permission Error

Token exists but lacks permission for requested action.

404 Not Found

Resource Missing

Wrong endpoint, resource ID doesn't exist.

422 Validation Error

Validation Issue

Missing required fields or invalid field values.

429 Too Many Requests

Rate Limited

Slow down API call frequency β€” implement backoff/retries.

500 Server Error

Operator AI Server Issue

Temporary problem β€” retry the request later.

βœ… Error codes are the fastest way to understand what went wrong.


πŸ› οΈ Example Error Response Format

Example when trying to create a user without required fields:

jsonCopyEdit{
  "error": {
    "code": 422,
    "message": "Validation error: Email is required."
  }
}

βœ… All error responses return standardized JSON for easy parsing and debugging.


πŸ”₯ Fast Troubleshooting Tips

Problem
How to Fix

Missing field errors

Double-check required fields in your request body.

Unauthorized errors (401)

Reconfirm your Bearer Token is active and correct.

403 Permission errors

Check if your API token has correct scopes (coming soon).

404 errors

Verify the endpoint and resource ID you're targeting.

429 Too Many Requests

Implement retry logic with exponential backoff.

βœ… Debugging quickly = less downtime and faster scaling.


πŸ“‹ Best Practices for Error Handling

Tip
Why It Matters

Always check response codes before assuming success

Don't build on bad assumptions.

Implement retries for 429 and 5xx errors

Avoid lost data and bad user experiences.

Log all failed requests

Makes troubleshooting future issues easier.

Validate API payloads before sending

Catch errors early in your code.

Securely handle and store error logs

Protect sensitive error data.

βœ… Strong error handling = professional-grade integrations.


πŸ›Ÿ Need Help?

  • Explore API troubleshooting tutorials inside this documentation.

  • Contact support@heyoperator.ai for debugging assistance.

  • Your Success Manager can review your integration if you're on a scaling plan.

βœ… We’re here to keep your Operator AI workflows smooth and resilient.


🎯 End of API Section!

πŸ‘‰ Continue to Operator AI Affiliate Program β†’

PreviousExample API RequestsNextπŸ“’ Operator AI Affiliate Program

Last updated 2 months ago

🚫