Create Template

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

Creates a report template in your Confident AI project and returns its id. The description is the question the report answers; send templateSections to fix its structure, and a cadence to control when it generates. Without a cadence it repeats every 1 day.

POST/v2/report-templates

curl -X POST "https://api.confident-ai.com/v2/report-templates" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "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.",
  "templateSections": [
    {
      "id": "<REPORT-TEMPLATE-SECTION-ID>",
      "type": "CONTENT",
      "heading": "What'\''s Failing",
      "useAI": true,
      "prompt": "Summarize the dominant failure modes in 2-4 sentences, citing error counts.",
      "content": {
        "text": "Generated daily for the platform team.",
        "severity": "INFO"
      },
      "startOnNewPage": false
    }
  ],
  "enabled": true,
  "recurrence": "ONCE",
  "repeatEvery": 1,
  "repeatUnit": "MINUTE",
  "startAt": "2025-02-01T09:00:00Z",
  "maxRuns": 12,
  "endAt": "2025-12-31T23:59:59Z"
}'

200

{
  "success": true,
  "data": {
    "id": "<REPORT-TEMPLATE-ID>"
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request body

namestringRequired
The template's name, also used as the report's title.
descriptionstring | null
The question the report should answer, written as a question. Supply this even when providing sections — it drives the single data retrieval that serves them all.
templateSectionslist of objects
The report's exact sections, in render order. Omit it to let the generator choose the structure from description.
Show 7 propertiesHide 7 properties
- idstring
  The id of the section. Send the id a section was read back with to keep its creation time across a rewrite; omit it and Confident AI assigns one.
- typeenumRequired
  What a section renders as. STAT_CARDS, TABLE and GRAPH must be AI-authored; CONTENT and ADMONITION can be either AI-authored or hardcoded.
  Show 5 enum valuesHide 5 enum values
  - CONTENT
  - STAT_CARDS
  - TABLE
  - GRAPH
  - ADMONITION
- headingstring | null
  The heading rendered above the section. Omit it for an unheaded section.
- useAIboolean
  Whether the generator authors this section from prompt. Defaults to false, which renders content verbatim instead.
- promptstring | null
  Required when useAI is true: a single directive for what this section must cover.
- contentobject | null
  The static content of a hardcoded (non-AI) template section. Null for AI-authored sections, which are written by the generator from their prompt.
  Show 2 propertiesHide 2 properties
  - textstring | null
    The section's literal text, written verbatim into every generated report.
  - severityenum | null
    The callout style of an ADMONITION section, from an informational note to a danger warning.
    Show 4 enum valuesHide 4 enum values
    INFO
    SUCCESS
    WARNING
    DANGER
- startOnNewPageboolean
  Whether the section starts on a new page in the exported report. Defaults to false.
enabledboolean
Whether to start generating on the schedule. Defaults to true; send false to create the template without scheduling it.
recurrenceenum
How often a schedule fires: ONCE runs a single time at startAt, INTERVAL repeats every repeatEvery repeatUnits.
Show 2 enum valuesHide 2 enum values
- ONCE
- INTERVAL
repeatEveryinteger | null
How many repeatUnits apart the runs are, for an INTERVAL schedule. Send null to clear it.
repeatUnitenum | null
The unit repeatEvery counts for an INTERVAL schedule.
Show 5 enum valuesHide 5 enum values
- MINUTE
- HOUR
- DAY
- WEEK
- MONTH
startAtstring | null
When the schedule first runs, as an ISO 8601 datetime. Send null to start it immediately.
maxRunsinteger | null
How many times the schedule runs before it stops. Send null to let it run indefinitely.
endAtstring | null
When the schedule stops running, as an ISO 8601 datetime. Send null to leave it open-ended.

Response

Create Template succeeded.

successboolean
Indicates if the request was successful.
dataobject
A reference to a report template by its id.
Show 1 propertyHide 1 property
- idstring
  The id of the report template, generated by Confident AI.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI