OpenAPI Specification
openapi: 3.1.0
info:
title: Opik REST Environments 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: Environments
description: Environment related resources
paths:
/v1/private/environments:
get:
tags:
- Environments
summary: Find environments
description: Find environments for the workspace. Capped at the workspace limit (default 20).
operationId: findEnvironments
responses:
'200':
description: Environments page
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentPage_Public'
post:
tags:
- Environments
summary: Create environment
description: Create environment
operationId: createEnvironment
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Environment_Write'
responses:
'201':
description: Created
headers:
Location:
required: true
style: simple
schema:
type: string
example: ${basePath}/v1/private/environments/{environmentId}
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
/v1/private/environments/delete:
post:
tags:
- Environments
summary: Delete environments
description: Delete environments batch. Idempotent — missing ids are silently ignored.
operationId: deleteEnvironmentsBatch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDelete'
responses:
'204':
description: No Content
/v1/private/environments/{id}:
get:
tags:
- Environments
summary: Get environment by id
description: Get environment by id
operationId: getEnvironmentById
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Environment
content:
application/json:
schema:
$ref: '#/components/schemas/Environment_Public'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage_Public'
patch:
tags:
- Environments
summary: Update environment by id
description: Update environment by id
operationId: updateEnvironment
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentUpdate'
responses:
'204':
description: No Content
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
components:
schemas:
ErrorMessage_Public:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: string
Environment_Write:
required:
- name
type: object
properties:
id:
type: string
format: uuid
name:
maxLength: 150
minLength: 0
pattern: ^[A-Za-z0-9_-]+$
type: string
description:
maxLength: 500
minLength: 0
type: string
color:
maxLength: 20
minLength: 0
type: string
position:
type: integer
format: int32
Environment_Public:
required:
- name
type: object
properties:
id:
type: string
format: uuid
name:
maxLength: 150
minLength: 0
pattern: ^[A-Za-z0-9_-]+$
type: string
description:
maxLength: 500
minLength: 0
type: string
color:
maxLength: 20
minLength: 0
type: string
position:
type: integer
format: int32
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
EnvironmentPage_Public:
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/Environment_Public'
sortableBy:
type: array
items:
type: string
EnvironmentUpdate:
type: object
properties:
name:
maxLength: 150
minLength: 0
pattern: ^[A-Za-z0-9_-]+$
type: string
description:
maxLength: 500
minLength: 0
type: string
color:
maxLength: 20
minLength: 0
type: string
position:
type: integer
format: int32
ErrorMessage:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: string
BatchDelete:
required:
- ids
type: object
properties:
ids:
maxItems: 1000
minItems: 1
uniqueItems: true
type: array
items:
type: string
format: uuid