Skip to main content
POST
Create a widget on a dashboard

Authorizations

X-Auth-Token
string
header
required

Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.

Path Parameters

dashboardId
string
required
Minimum string length: 1

Body

application/json
name
string
required
Required string length: 1 - 200
code
string
required
Required string length: 1 - 200000
queries
object[]
required
Maximum array length: 8
description
string
Required string length: 1 - 2000
prompt
string
Required string length: 1 - 2000
source
object

Response

The widget was saved on the dashboard

id
string
required
name
string
required
definition
object
required
createdAt
string
required
updatedAt
string
required
platformUrl
string
required
dashboardId
string | null
required
gridColumn
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
gridRow
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
colSpan
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
rowSpan
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
Last modified on October 27, 2026