List Templates

GEThttps://api.confident-ai.com/v2/report-templates

Lists the report templates in your Confident AI project one page at a time, oldest first. Retrieve a single template for its cadence and its sections.

GET/v2/report-templates

curl -X GET "https://api.confident-ai.com/v2/report-templates" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "reportTemplates": [
      {
        "id": "<REPORT-TEMPLATE-ID>",
        "name": "Weekly Health Check",
        "description": "Give me an overall health check for the last week: request volume, error rate, latency, total cost and user activity.",
        "type": "RISK_ASSESSMENT_REPORT",
        "enabled": true,
        "createdAt": "2025-01-01T00:00:00.000Z"
      }
    ],
    "totalReportTemplates": 3,
    "page": 1,
    "pageSize": 25
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of results per page, at most 100. Defaults to 25.

Response

List Templates succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of report templates, with the total across all pages.
Show 4 propertiesHide 4 properties
- reportTemplateslist of objects
  The report templates for the current page, oldest first.
  Show 6 propertiesHide 6 properties
  - idstring
    The id of the report template, generated by Confident AI.
  - namestring
    The template's name, also used as the report's title.
  - descriptionstring | null
    The question the generated report answers, which drives what data the generator retrieves.
  - typeenum | null
    The kind of report a template generates. Templates you create over the API generate executive reports; RISK_ASSESSMENT_REPORT belongs to the reports Confident AI generates for a risk assessment.
    Show 2 enum valuesHide 2 enum values
    RISK_ASSESSMENT_REPORT
    EXECUTIVE_REPORT
  - enabledboolean
    Whether scheduled generation is running. A disabled template generates nothing.
  - createdAtstring
    When the report template was created.
- totalReportTemplatesinteger
  The total number of report templates in this project.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of report templates per page.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI