Skip to main content

​
Overview

The Hyperaide API allows you to programmatically interact with your assistant, enabling integrations with external services, custom automations, and advanced workflows.

​
Base URL

https://api.hyperaide.com

​
Authentication

All API endpoints require authentication using an API key. Include your API key in the request headers: 
x-api-key: your_api_key_here

​
Getting Your API Key

  1. Log in to the Hyperaide web app
  2. Navigate to Settings → API Keys
  3. Click Create New API Key
  4. Copy and securely store your key
Keep your API key secure! Never commit API keys to version control or share them publicly. Treat them like passwords.

​
Core Endpoints

The Hyperaide API provides two primary endpoints for interacting with your assistant:

Instruct

Send instructions to your assistant for execution

Inform

Provide information to your assistant without expecting a response

​
Use Cases

Trigger your assistant from external automation tools like Zapier, Make, or n8n.Example: When a form is submitted, instruct your assistant to create tasks and send notifications.
Build custom integrations with services not natively supported by Hyperaide.Example: Connect your CRM system to automatically inform your assistant of new leads.
Connect IoT devices and smart home systems to your assistant.Example: When a sensor is triggered, instruct your assistant to log the event.
Feed external data into your assistant’s knowledge base.Example: Regularly inform your assistant about system metrics or analytics.
Send custom notifications or alerts to yourself through your assistant.Example: Server monitoring tools can instruct your assistant to alert you via WhatsApp.

​
Rate Limits

Current Rate Limits:
  • 100 requests per minute per API key
  • 10,000 requests per day per API key
Contact support if you need higher limits for your use case.

​
Error Handling

All endpoints return standard HTTP status codes:
Status CodeMeaning
200Success
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
404Not Found - Resource doesn’t exist
429Too Many Requests - Rate limit exceeded
500Internal Server Error
Error responses include a JSON body with details: 
{
  "error": "Error type",
  "message": "Detailed error message"
}

​
Best Practices

Secure Storage

Store API keys in environment variables or secure secret managers, never in code

Error Handling

Implement proper error handling and retry logic in your integrations

Rate Limiting

Respect rate limits and implement backoff strategies for retries

Logging

Log API requests for debugging and monitoring purposes

​
Support

Need help with the API? Contact us at jp@hyperaide.com or visit our community forum.