Skip to main content
POST
/
v1
/
alerts
/
{alert_token}
/
ai-research
Trigger AI research
curl --request POST \
  --url https://instance.prod.onboardapp.io/v1/alerts/{alert_token}/ai-research \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "research_type": "standard"
}
'
{
  "data": {
    "status": "processing",
    "estimated_completion": "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.

Headers

​
Idempotency-Key
string<uuid>

Unique key for idempotent request handling. If a request with the same key was already processed within the last 24 hours, the original response is returned.

Path Parameters

​
alert_token
string
required

Alert token.

Body

application/json
​
research_type
enum<string>
default:standard

Research depth. standard provides quick analysis (30-60s). deep performs comprehensive investigation (2-5 minutes).

Available options:
standard,
deep

Response

AI research initiated.

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

​
data
object

Response payload. Type varies by endpoint.

​
meta
object