API Reference / Finance - ROI

Check ROI generation job status

get https://api.intelig.ai/api/v1/intelig/finance/roi/generate/status

Auth: Authorization: ApiKey <key> (an API key sent as Bearer is rejected) or Authorization: Bearer <jwt> for a dashboard session. operationId: getGenerationStatus

Poll this endpoint to check the status of an async ROI AI generation job.

Example request

curl -X GET "https://api.intelig.ai/api/v1/intelig/finance/roi/generate/status?jobId=string" \
  -H "Authorization: ApiKey $INTELIG_API_KEY"

Query parameters

NameTypeRequiredDescription
jobId string (uuid) yes

Response 200

application/json · ApiResponseAiGenerationStatusDto

FieldTypeDescription
success boolean
message string
data AiGenerationStatusDto

Status codes

  • 200 — Job status returned
  • 401 — —
  • 404 — Job not found
  • 429 — —

Every response is wrapped in { success, message, data }. A 4xx means the request is wrong — do not retry it unchanged. A 429 carries Retry-After in seconds.