openapi: 3.1.0
info:
  title: Opik REST Welcome Wizard API
  description: "The Opik REST API is currently in beta and subject to change. If you have any questions or feedback about the APIs, please reach out on GitHub: https://github.com/comet-ml/opik.\n\nAll of the methods listed in this documentation are used by either the SDK or the UI to interact with the Opik server. As a result,\nthe methods have been optimized for these use-cases in mind. If you are looking for a method that is not listed above, please create\nand issue on GitHub or raise a PR!\n\nOpik includes two main deployment options that results in slightly different API usage:\n\n- **Self-hosted Opik instance:** You will simply need to specify the URL as `http://localhost:5173/api/<endpoint_path>` or similar. This is the default option for the docs.\n- **Opik Cloud:** You will need to specify the Opik API Key and Opik Workspace in the header. The format of the header should be:\n\n  ```\n  {\n    \"Comet-Workspace\": \"your-workspace-name\",\n    \"authorization\": \"your-api-key\"\n  }\n  ```\n\n  The full payload would therefore look like:\n  \n  ```\n  curl -X GET 'https://www.comet.com/opik/api/v1/private/projects' \\\n  -H 'Accept: application/json' \\\n  -H 'Comet-Workspace: <your-workspace-name>' \\\n  -H 'authorization: <your-api-key>'\n  ```\n\n  Do take note here that the authorization header value does not include the `Bearer ` prefix. To switch to using the Opik Cloud in the documentation, you can\n  click on the edit button displayed when hovering over the `Base URL` displayed on the right hand side of the docs.\n"
  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: Welcome Wizard
  description: Welcome wizard tracking resources
paths:
  /v1/private/welcome-wizard:
    get:
      tags:
      - Welcome Wizard
      summary: Get welcome wizard tracking status
      description: Get welcome wizard tracking status for the current workspace
      operationId: getWelcomeWizardStatus
      responses:
        '200':
          description: Welcome wizard tracking status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WelcomeWizardTracking'
    post:
      tags:
      - Welcome Wizard
      summary: Submit welcome wizard
      description: Submit welcome wizard with user information
      operationId: submitWelcomeWizard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WelcomeWizardSubmission'
      responses:
        '204':
          description: Welcome wizard submitted successfully
components:
  schemas:
    WelcomeWizardSubmission:
      type: object
      properties:
        role:
          maxLength: 100
          minLength: 0
          type: string
          description: Optional user role
        integrations:
          type: array
          description: List of integrations the user selected
          items:
            type: string
            description: List of integrations the user selected
        email:
          maxLength: 255
          minLength: 0
          type: string
          description: Optional user email
          format: email
        join_beta_program:
          type: boolean
          description: Whether user wants to join beta programs
    WelcomeWizardTracking:
      type: object
      properties:
        completed:
          type: boolean
          description: Whether the welcome wizard has been completed