API Documentation

Integrate OpenHelix AI into your applications with our REST API.

Base URL

https://openhelixai.com/api/v1

Authentication

Include your API key in the request headers:

X-API-Key: your_api_key_here

💡 Generate API keys from your dashboard. Keep your API keys secure and never share them.

Endpoints

POST/api/v1/chat

Send a message to your AI agent

🔒 API Key required

Request Body

{
  "instanceId": "your-instance-id",
  "message": "Hello, how can you help me?"
}

Response

{
  "response": "I'd be happy to help! I can assist with...",
  "messageId": "msg_1234567890"
}

GET/api/v1/instances

List all your AI instances

🔒 Session or API Key

Response

[
  {
    "id": "instance-id",
    "name": "My AI Agent",
    "status": "running",
    "type": "assistant"
  }
]

POST/api/instances/{id}/credentials

Add credentials to an instance

🔒 Session required

Request Body

{
  "key": "openai_api_key",
  "value": "sk-..."
}

Response

{
  "success": true,
  "key": "openai_api_key"
}

Example: cURL

curl -X POST "https://openhelixai.com/api/v1/chat" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key_here" \
  -d '{
    "instanceId": "your-instance-id",
    "message": "Hello, how can you help me?"
  }'

Need help? Contact our support team