Skip to main content
POST
Create an on-demand or scheduled report
To install and sign in to the CLI, see Call from the CLI.

Authorizations

x-coderabbitai-api-key
string
header
required

See Authentication for the key types and where to create a key.

Body

application/json
name
string
required
Maximum string length: 255
time
string
required
Maximum string length: 255
timezone
string
required
Maximum string length: 255
parameters
object[]
required
Maximum array length: 7
emails
string<email>[]
required
Maximum array length: 100
Maximum string length: 320
promptTemplate
enum<string>
required
Available options:
Daily Standup Report,
Sprint Report,
Release Notes,
Organization Stats,
Custom
type
enum<string>
required
Available options:
ONDEMAND
from
string
required
Maximum string length: 255
to
string
required
Maximum string length: 255
org_id
string

Organization for a workspace key: the Git-provider organization ID (scope.provider_organization_id) or the CodeRabbit organization ID (scope.id, or id from list organizations). Supply either org_id or org_name, never both. Omit for organization keys and MCP connections.

Minimum string length: 1
org_name
string

GitHub organization login, such as coderabbitai, not its display name. Matched case-insensitively within the authenticated workspace. Supply either org_name or org_id, never both; omit for organization keys and MCP connections.

Pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$
group
enum<string>
Available options:
NONE,
REPOSITORY,
LABEL,
TEAM,
USER,
SOURCEBRANCH,
TARGETBRANCH,
STATE
subgroup
enum<string>
Available options:
NONE,
REPOSITORY,
LABEL,
TEAM,
USER,
SOURCEBRANCH,
TARGETBRANCH,
STATE
platform
enum<string>
Available options:
SLACK,
DISCORD,
EMAIL,
TEAMS
channel
string
Maximum string length: 2048
prompt
string
Maximum string length: 8192

Response

OK

report_id
string
required