Skip to main content
curl --request POST \
  --url https://api.heliosai.health/api/v1/agent \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "webhookUrl": "https://your-server.com/webhook/helios",
  "agentType": "light",
  "data": {
    "patientInfo": {
      "age": 45
    },
    "recentAbnormalLabs": [
      {
        "date": "2025-01-05",
        "display": "Hemoglobin A1c",
        "value": "7.2",
        "unit": "%"
      }
    ]
  }
}
'
{
  "runId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "accepted",
  "message": "Request accepted. Results will be delivered to your webhook."
}

Authorizations

​
x-api-key
string
header
required

API key provided by Helios Intelligence

Body

application/json
​
webhookUrl
string<uri>
required

URL where analysis results will be delivered via webhook

Example:

"https://your-server.com/webhook/helios"

​
agentType
enum<string>
required

Type of analysis to perform

Available options:
light,
deep
Example:

"light"

​
data
object
required

Patient health data for analysis. All fields are optional except at least some health data should be provided.

Response

Request accepted - analysis started in background

​
runId
string<uuid>
required

Unique identifier for this analysis run

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
status
enum<string>
required

Request was accepted and processing has started in the background

Available options:
accepted
Example:

"accepted"

​
message
string

Human-readable status message

Example:

"Request accepted. Results will be delivered to your webhook."