Rulebase Report Authoring API
The Report Authoring API from Rulebase — 5 operation(s) for report authoring.
The Report Authoring API from Rulebase — 5 operation(s) for report authoring.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/rulebase:rulebase-report-authoring-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Rulebase API2 Report Authoring API
version: 0.0.1
tags:
- name: Report Authoring
paths:
/report-authoring/starters:
get:
responses:
'200':
description: Ready-made reports to start a schedule from
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
key:
type: string
name:
type: string
description:
type: string
subjectKind:
type: string
enum:
- workspace
- team
- agent
instructions:
type: string
schema:
type: object
additionalProperties:
nullable: true
template:
type: string
required:
- key
- name
- description
- subjectKind
- instructions
- schema
- template
required:
- data
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
tags:
- Report Authoring
summary: Get report authoring starters
x-summary-source: derived
operationId: getReportAuthoringStarters
x-operation-id-source: derived
/report-authoring/instructions:
post:
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
prompt:
type: string
minLength: 1
maxLength: 2000
instructions:
type: string
nullable: true
maxLength: 50000
subjectKind:
type: string
enum:
- workspace
- team
- agent
required:
- prompt
- instructions
- subjectKind
responses:
'200':
description: The instructions with the requested change applied, and the definition compiled from them
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
instructions:
type: string
schema:
type: object
additionalProperties:
nullable: true
template:
type: string
required:
- instructions
- schema
- template
required:
- data
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'422':
description: The change could not be applied
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
tags:
- Report Authoring
summary: Create report authoring instructions
x-summary-source: derived
operationId: postReportAuthoringInstructions
x-operation-id-source: derived
/report-authoring/subjects:
get:
parameters:
- schema:
type: string
enum:
- team
- agent
required: true
name: kind
in: query
responses:
'200':
description: Teams or agents a preview can be written for
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
teamName:
type: string
nullable: true
required:
- id
- name
- teamName
required:
- data
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
tags:
- Report Authoring
summary: Get report authoring subjects
x-summary-source: derived
operationId: getReportAuthoringSubjects
x-operation-id-source: derived
/report-authoring/previews:
post:
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 200
instructions:
type: string
minLength: 1
maxLength: 50000
schema:
type: object
additionalProperties:
nullable: true
template:
type: string
minLength: 1
subjectKind:
type: string
enum:
- workspace
- team
- agent
subjectId:
type: integer
nullable: true
periodStart:
type: string
pattern: ^\d{4}-\d{2}-\d{2}$
periodEnd:
type: string
pattern: ^\d{4}-\d{2}-\d{2}$
reportTypeId:
type: string
nullable: true
required:
- name
- instructions
- schema
- template
- subjectKind
- subjectId
- periodStart
- periodEnd
responses:
'202':
description: The preview was queued
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
previewId:
type: string
required:
- previewId
required:
- data
'400':
description: Invalid preview request
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
tags:
- Report Authoring
summary: Create report authoring previews
x-summary-source: derived
operationId: postReportAuthoringPreviews
x-operation-id-source: derived
/report-authoring/previews/{previewId}:
get:
parameters:
- schema:
type: string
required: true
name: previewId
in: path
responses:
'200':
description: The preview's state, with the report once it is ready
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
status:
type: string
enum:
- generating
- ready
- failed
progress:
type: string
nullable: true
title:
type: string
nullable: true
content:
type: string
nullable: true
required:
- status
- progress
- title
- content
required:
- data
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'404':
description: Preview not found
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
tags:
- Report Authoring
summary: Get report authoring previews by preview id
x-summary-source: derived
operationId: getReportAuthoringPreviewsByPreviewId
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Rulebase organization API key