Skip to main content

​
Overview

The /inform endpoint allows you to provide information to your Hyperaide assistant without triggering any immediate actions. Use this when you want to add context or data to your assistant’s knowledge base for future reference.
Use this endpoint when you want to share information with your assistant but don’t need it to take action. The information becomes part of your conversation history and can be referenced later.

​
Endpoint

POST https://api.hyperaide.com/inform

​
Authentication

Include your API key in the request headers: 
x-api-key: your_api_key_here

​
Request Body

​
content
string
required
The information you want to share with your assistant. Can be any text, data, or context you want to make available.Example: "The deployment to production completed successfully at 3:45 PM"

​
Request Example

curl -X POST https://api.hyperaide.com/inform \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "The deployment to production completed successfully at 3:45 PM"
  }'

​
Response

​
Success Response (200 OK)

{
  "message": "Hyperaide informed"
}
The information has been recorded and is now available to your assistant for future reference.
Unlike /instruct, this endpoint doesn’t trigger your assistant to take actions. It simply records the information as context.

​
Error Responses

Missing or invalid API key
{
  "error": "Invalid API key"
}
Verify your API key is correct and included in the x-api-key header.
User not found
{
  "error": "User not found"
}
The API key is valid but the associated user doesn’t exist. Contact support.

​
Inform vs Instruct

Understanding when to use each endpoint:
  • Use Inform When
  • Use Instruct When
You want to provide context without triggering actions✅ Logging events for future reference
✅ Recording metrics or status updates
✅ Feeding data into your assistant’s knowledge base
✅ Building context for later queries
✅ Passive information sharing
// Example: Log deployment status
await fetch('https://api.hyperaide.com/inform', {
  method: 'POST',
  headers: { 'x-api-key': apiKey, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    content: 'Deployment v2.3.1 completed at 15:30 UTC'
  })
});

​
Use Cases

  • Activity Logging
  • Status Updates
  • Data Ingestion
  • Context Building
Keep your assistant informed about system events
// Log user activity
await fetch('https://api.hyperaide.com/inform', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.HYPERAIDE_API_KEY,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    content: `User ${username} completed onboarding at ${timestamp}`
  })
});
Later, you can ask your assistant: “How many users completed onboarding this week?”

​
Best Practices

Structured Information

Include relevant details and structure your information clearly for easy reference

Consistent Format

Use consistent formats for similar types of information to help your assistant recognize patterns

Relevant Context

Include timestamps, identifiers, and context that makes the information useful later

Batch When Possible

For multiple related updates, consider combining them into a single inform call

​
Example Workflow

Here’s how inform and instruct work together: 
// 1. Inform about an event (no action)
await fetch('https://api.hyperaide.com/inform', {
  method: 'POST',
  headers: { 'x-api-key': apiKey, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    content: 'Server CPU reached 85% at 14:23 UTC'
  })
});

// 2. If threshold exceeded, instruct to take action
if (cpuUsage > 90) {
  await fetch('https://api.hyperaide.com/instruct', {
    method: 'POST',
    headers: { 'x-api-key': apiKey, 'Content-Type': 'application/json' },
    body: JSON.stringify({
      content: 'Server CPU critical at 92%. Send alert via WhatsApp and create incident task.'
    })
  });
}

// 3. Later, ask your assistant
// "What was the server CPU pattern today?"
// Your assistant can reference the informed data to provide insights

​
How Information is Used

Information sent via /inform:
  1. Stored in Context: Added to your conversation history
  2. Searchable: Can be referenced in future queries
  3. Analyzed: Your assistant can identify patterns and trends
  4. Recalled: Available when relevant to future conversations
Think of /inform as feeding your assistant’s memory. It doesn’t trigger actions, but enriches your assistant’s understanding of your world.

POST /instruct

Use this endpoint when you want your assistant to take action on information