Skip to main content
POST
Create a reusable definition
Required scopes: metrics:write.

Authorizations

x-chatobserver-key
string
header
required

A workspace API key. Data endpoints require a service-account key with the specified scopes.

Headers

Idempotency-Key
string
required

Unique key for one logical command. Reuse it only when retrying the same request and payload.

Required string length: 16 - 160
Pattern: ^[A-Za-z0-9:_-]+$

Path Parameters

resourceType
enum<string>
required

The definition collection. The definition body must match this resource type.

Available options:
custom-fields,
blends,
models,
table-groups,
imported-datasets,
client-bindings

Body

application/json
name
string
required
Required string length: 1 - 150
definition
object
required
description
string | null
Maximum string length: 4000
visibility
string

Service-account resources must be visible to the workspace.

Allowed value: "workspace"
publish
boolean
default:false

Response

Successful response.

data
object
required
replayed
required