Comet Agent Insights Jobs API

Per-(workspace, project) Agent Insights report configuration

Operations 4

GET /v1/private/agent-insights/jobs/{projectId} Get Agent Insights job #
POST /v1/private/agent-insights/jobs/{projectId} Create Agent Insights job #
PATCH /v1/private/agent-insights/jobs/{projectId} Update Agent Insights job #
POST /v1/private/agent-insights/jobs/{projectId}/trigger Trigger Agent Insights job #

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/comet-agent-insights-jobs-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

comet-agent-insights-jobs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Opik REST Agent Insights Jobs 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: Agent Insights Jobs
  description: Per-(workspace, project) Agent Insights report configuration
paths:
  /v1/private/agent-insights/jobs/{projectId}:
    get:
      tags:
      - Agent Insights Jobs
      summary: Get Agent Insights job
      description: Returns the Agent Insights job for the (workspace, project), or 404 if none exists.
      operationId: getAgentInsightsJob
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Job
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentInsightsJob'
        '404':
          description: Job not found
    post:
      tags:
      - Agent Insights Jobs
      summary: Create Agent Insights job
      description: Creates the Agent Insights job for a project. 409 if one already exists.
      operationId: createAgentInsightsJob
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '201':
          description: Job created
          headers:
            Location:
              description: URI of the created job
              style: simple
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentInsightsJob'
        '404':
          description: Project not found
        '409':
          description: Job already exists
    patch:
      tags:
      - Agent Insights Jobs
      summary: Update Agent Insights job
      description: Partially updates the Agent Insights job for a project (e.g. status; never deletes). Returns the updated job, or 404 if none exists.
      operationId: updateAgentInsightsJob
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentInsightsJobUpdate'
        required: true
      responses:
        '200':
          description: Job updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentInsightsJob'
        '404':
          description: Job not found
  /v1/private/agent-insights/jobs/{projectId}/trigger:
    post:
      tags:
      - Agent Insights Jobs
      summary: Trigger Agent Insights job
      description: Triggers an immediate report run for an existing job (over the last 24h). Fire-and-forget; returns 202. 404 if none exists.
      operationId: triggerAgentInsightsJob
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '202':
          description: Run accepted
        '404':
          description: Job not found
components:
  schemas:
    AgentInsightsJobUpdate:
      required:
      - status
      type: object
      properties:
        status:
          type: string
          description: New status for the job
          enum:
          - enabled
          - disabled
    AgentInsightsJob:
      required:
      - project_id
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        project_id:
          type: string
          format: uuid
          readOnly: true
        status:
          type: string
          readOnly: true
          enum:
          - enabled
          - disabled
        last_scan_at:
          type: string
          format: date-time
          readOnly: true
        last_failure_reason:
          type: string
          readOnly: true
        last_failure_detail:
          type: string
          readOnly: true
        last_failed_at:
          type: string
          format: date-time
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        created_by:
          type: string
          readOnly: true
        last_updated_at:
          type: string
          format: date-time
          readOnly: true
        last_updated_by:
          type: string
          readOnly: true