Create dashboard | Opik Documentation

POST/v1/private/dashboardsCreate dashboard

Create a new dashboard in a workspace

Request body

application/json

objectDashboard_Write

configobjectrequired

descriptionstring

maxLength 1000 · minLength 0

namestringrequired

maxLength 120 · minLength 1

project_idstring · uuid

Project ID. Takes precedence over project_name when both are provided.

project_namestring

For project scope, specify either project_id or project_name. If project_name is provided and the project does not exist, it will be created. Ignored when project_id is provided. If neither is provided, the dashboard is created at workspace level.

pattern (?s)^\s*(\S.*\S|\S)\s*$

typestring

one of "multi_project", "experiments"

Example request

{
  "config": {},
  "description": "string",
  "name": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "project_name": "string",
  "type": "experiments"
}

Responses

Headers

Location

objectDashboard_Public

configobjectrequired

created_atstring · date-time

created_bystring

descriptionstring

maxLength 1000 · minLength 0

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

namestringrequired

maxLength 120 · minLength 1

project_idstring · uuid

Project ID. Takes precedence over project_name when both are provided.

scopestring

one of "workspace", "insights"

slugstring

typestring

one of "multi_project", "experiments"

workspace_idstring

Example response

{
  "config": {},
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "description": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "name": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "scope": "insights",
  "slug": "string",
  "type": "experiments",
  "workspace_id": "string"
}

Examples

curl -X POST 'http://localhost:5173/api/v1/private/dashboards' \
  -H 'Content-Type: application/json' \
  -d '{"config":{},"description":"string","name":"string","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","type":"experiments"}'

const response = await fetch('http://localhost:5173/api/v1/private/dashboards', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"config":{},"description":"string","name":"string","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","type":"experiments"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/dashboards', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"config\":{},\"description\":\"string\",\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"type\":\"experiments\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/dashboards",
    headers={"Content-Type": "application/json"},
    data='{"config":{},"description":"string","name":"string","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","type":"experiments"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"config":{},"description":"string","name":"string","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","type":"experiments"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/dashboards", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/dashboards");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"config\":{},\"description\":\"string\",\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"type\":\"experiments\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/dashboards"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"config\":{},\"description\":\"string\",\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"type\":\"experiments\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/dashboards")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"config\":{},\"description\":\"string\",\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"type\":\"experiments\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/dashboards");
request.Content = new StringContent("{\"config\":{},\"description\":\"string\",\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"type\":\"experiments\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "config": {},
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "description": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "name": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "scope": "insights",
  "slug": "string",
  "type": "experiments",
  "workspace_id": "string"
}