Analyse Report Data with AI

post

https://talk.perspio.io/reports/v3/{id}/ai/analyse

Submit report data for AI analysis. On success, metadata.perspioAITokens is billed Perspio AI tokens (PATs), not the raw LLM tokensUsed count.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

JSON schema describing the report shape.

Query Params

model

string

Optional model override. Canonical channel for overriding the model; takes precedence over the deprecated AIAnalysisRequest.model body field when both are supplied.

Body Params

AI analysis request: send skillId and reportRunId. The service loads report CSV and context from the report-run artifact store.

JSON schema describing the report shape.

tenantId

string

Identifier of the owning tenant.

userId

string

User Id.

correlationId

string

Client-supplied correlation id, echoed back for request tracing.

skillId

string

required

Skill id to execute.

reportDefinitionId

string

Report Definition Id.

reportRunId

string

required

Identifies saved report-run artifacts (CSV + metadata) loaded server-side.

agentId

string | null

Agent Id.

model

string | null

deprecated

Deprecated. Prefer the model query parameter on analyse/estimate/validate, which takes precedence over this body field when both are supplied. Scheduled for removal after 2026-04-15.

userQuery

string | null

User Query.

context

object | null

Responses

401

Invalid API Key provided or Invalid Bearer token

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Invalid Request

500Internal Server Error