Opik Reports API

Ollie daily report management

Operations 5

POST /v1/private/projects/{projectId}/reports/{reportId}/complete Complete report generation #
POST /v1/private/projects/{projectId}/reports/generate Trigger report generation #
GET /v1/private/projects/{projectId}/reports/preferences Get report preferences #
PUT /v1/private/projects/{projectId}/reports/preferences Update report preferences #
GET /v1/private/projects/{projectId}/reports Get reports for a project #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/opik-reports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API 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 Specification

opik-reports-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Opik REST Reports API
  description: The Opik REST API is currently in beta and subject to change.
  contact:
    name: Github Repository
    url: https://github.com/comet-ml/opik
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
servers:
- url: http://localhost:5173/api
  description: Local server
- url: https://www.comet.com/opik/api
  description: Opik Cloud
tags:
- name: Reports
  description: Ollie daily report management
paths:
  /v1/private/projects/{projectId}/reports/{reportId}/complete:
    post:
      tags:
      - Reports
      summary: Complete report generation
      description: Callback from Ollie to update report status and content after generation.
      operationId: completeReport
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: reportId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportCompleteRequest'
      responses:
        '204':
          description: Report updated
        '404':
          description: Report not found
  /v1/private/projects/{projectId}/reports/generate:
    post:
      tags:
      - Reports
      summary: Trigger report generation
      description: Creates a pending report and triggers asynchronous generation via the orchestrator.
      operationId: generateReport
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '202':
          description: Report generation triggered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateReportResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /v1/private/projects/{projectId}/reports/preferences:
    get:
      tags:
      - Reports
      summary: Get report preferences
      description: Returns report preferences for a project, or null if none have been set.
      operationId: getReportPreference
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Report preferences or null
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportPreference'
    put:
      tags:
      - Reports
      summary: Update report preferences
      description: Enable or disable daily report generation for a project.
      operationId: updateReportPreference
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportPreference'
      responses:
        '200':
          description: Updated preferences
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportPreference'
  /v1/private/projects/{projectId}/reports:
    get:
      tags:
      - Reports
      summary: Get reports for a project
      description: Returns a paginated list of reports, newest first.
      operationId: getReports
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: page
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
          default: 1
      - name: size
        in: query
        schema:
          maximum: 100
          minimum: 1
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: Reports page
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OllieReportPage'
components:
  schemas:
    ReportCompleteRequest:
      required:
      - status
      type: object
      properties:
        content:
          type: string
        status:
          type: string
          enum:
          - pending
          - completed
          - failed
        session_id:
          type: string
        recommended_actions:
          $ref: '#/components/schemas/JsonNode'
    OllieReportPage:
      type: object
      properties:
        page:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
        total:
          type: integer
          format: int64
        content:
          type: array
          items:
            $ref: '#/components/schemas/OllieReport'
    OllieReport:
      type: object
      properties:
        id:
          type: string
          format: uuid
        project_id:
          type: string
          format: uuid
        session_id:
          type: string
        content:
          type: string
        recommended_actions:
          $ref: '#/components/schemas/JsonNode'
        status:
          type: string
          enum:
          - pending
          - completed
          - failed
        created_at:
          type: string
          format: date-time
          readOnly: true
        last_updated_at:
          type: string
          format: date-time
          readOnly: true
    GenerateReportResponse:
      type: object
      properties:
        reportId:
          type: string
          format: uuid
      description: Response for report generation trigger
    JsonNode:
      type: object
    ReportPreference:
      type: object
      properties:
        project_id:
          type: string
          format: uuid
        enabled:
          type: boolean
        schedule_time:
          pattern: \d{2}:\d{2}:\d{2}
          type: string
        custom_prompt:
          maxLength: 5000
          minLength: 0
          type: string
        created_at:
          type: string
          format: date-time
          readOnly: true
        last_updated_at:
          type: string
          format: date-time
          readOnly: true