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-pairing-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Opik REST Pairing 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: Pairing
  description: Pairing sessions for the `opik connect` and `opik endpoint` CLI commands
paths:
  /v1/private/pairing/sessions/{sessionId}/activate:
    post:
      tags:
      - Pairing
      summary: Activate a pairing session
      description: Verify the activation HMAC and flip the runner row to CONNECTED
      operationId: activatePairingSession
      parameters:
      - name: sessionId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivateRequest'
      responses:
        '201':
          description: Session activated
          headers:
            Location:
              description: URI of the runner
              style: simple
        '403':
          description: Invalid HMAC
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Session not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '409':
          description: Session already activated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
  /v1/private/pairing/sessions:
    post:
      tags:
      - Pairing
      summary: Create a pairing session
      description: Register a short-lived pairing session that a local daemon will later activate via HMAC
      operationId: createPairingSession
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSessionRequest'
      responses:
        '201':
          description: Session created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSessionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Project not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
components:
  schemas:
    CreateSessionResponse:
      type: object
      properties:
        session_id:
          type: string
          format: uuid
        runner_id:
          type: string
          format: uuid
    CreateSessionRequest:
      required:
      - activation_key
      - project_id
      - type
      type: object
      properties:
        project_id:
          type: string
          format: uuid
        activation_key:
          maxLength: 44
          minLength: 43
          type: string
        ttl_seconds:
          maximum: 600
          minimum: 60
          type: integer
          format: int32
        type:
          type: string
          enum:
          - connect
          - endpoint
    ErrorMessage:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: string
    ActivateRequest:
      required:
      - hmac
      - runner_name
      type: object
      properties:
        runner_name:
          maxLength: 128
          minLength: 0
          type: string
        hmac:
          maxLength: 44
          minLength: 43
          type: string