REST API
Arcanna.ai exposes a REST API. The Swagger describing all endpoints can be found at http://<your-arcanna.ai-url>:9666/docs.
Authentication
Authentication is done using the x-arcanna-api-key header and the token generated from: Arcanna.ai UI -> Profile (top right) -> API Keys.
Events
POST /api/v1/events
Send an event to Arcanna
Request body:
{
"job_id": 0,
"severity": 0,
"data_source": "string",
"title": "string",
"raw_body": {}
}
Response:
{
"event_id": "string",
"job_id": 0,
"ingest_timestamp": "string",
"status": "string",
"error_message": "string"
}
GET /api/v1/{job_id}/{event_id}
Retrieve the event decision
Parameters: job_id, event_id
Response:
{
"event_id": "string",
"ingest_timestamp": "string",
"status": "string",
"confidence_level": 0,
"result": "string",
"is_duplicated": true,
"error_message": "string"
}
Feedback
PUT /api/v1/{job_id}/{event_id}/feedback
Updates the feedback on the event
Request body:
{
"job_id": 0,
"event_id": "string",
"username": "string",
"label": "string",
"closing_notes": "string"
}
Response:
{
"status": "string"
}
Health
GET /api/v1/health
Parameters: None
GET /api/v1/health/check
Parameters: None
Jobs
GET /api/v1/jobs
The lists the AI jobs.
Parameters: None
Response:
[
{
"job_id": 0,
"data_type": "string",
"title": "string",
"status": "string",
"labels": [
"string"
],
"features": [
"string"
]
}
]