Skip to main content
GET
/
v1
/
alerts
/
{alert_token}
/
ai-research
Get AI research results
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/alerts/{alert_token}/ai-research \
  --header 'X-API-KEY: <api-key>'
{
  "data": {
    "alert_token": "<string>",
    "research_type": "standard",
    "status": "complete",
    "summary": "<string>",
    "confidence_score": 50,
    "risk_indicators": [
      {
        "indicator": "<string>",
        "severity": "high",
        "evidence": "<string>"
      }
    ],
    "recommended_action": "Approve",
    "sources": [
      {
        "title": "<string>",
        "url": "<string>",
        "relevance": 123
      }
    ],
    "completed_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "req_9k4m2n1p3q",
    "page": {
      "cursor": "<string>",
      "has_more": true
    }
  }
}

Authorizations

X-API-KEY
string
header
required

Project-scoped API key for server-to-server authentication. Obtain keys from the Zenoo dashboard under Project Settings > API Keys. Staging and production environments use separate keys.

Path Parameters

alert_token
string
required

Alert token.

Response

AI research results.

Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.

data
object

AI-powered research result for an alert, including structured analysis, confidence scoring, source citations, and recommended actions.

meta
object