Skip to main content
POST
/
api
/
v1
/
automations
/
{id}
/
examples
Create dataset example
curl --request POST \
  --url https://studio.eigenpal.com/api/v1/automations/{id}/examples \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "input": {},
  "expected": "<unknown>",
  "metadata": {},
  "annotation": "<string>",
  "rowOrder": 4503599627370495,
  "overrides": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "automationId": "<string>",
  "input": {},
  "expected": "<unknown>",
  "expectedFiles": [
    {
      "name": "<string>",
      "url": "<string>"
    }
  ],
  "metadata": {},
  "annotation": "<string>",
  "rowOrder": 123,
  "overrides": {},
  "latestRunId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key issued from Settings → API Keys. Pass as Authorization: Bearer <key>.

Path Parameters

​
id
string
required

Automation id or typed alias, such as workflows.slug or agents.slug.

Body

application/json

Fields used to create or update a dataset example.

​
name
string | null

Example name. Required on create; omitted or null uses a generated name where supported.

Required string length: 1 - 128
​
input
object

Input arguments for the example.

​
expected
any | null

Expected JSON output. Null clears the expected output.

​
metadata
object

Caller-managed metadata.

​
annotation
string | null

Human note about the example. Null clears the annotation.

Maximum string length: 2000
​
rowOrder
integer | null

Optional display order. Null clears the order.

Required range: 0 <= x <= 9007199254740991
​
overrides
object

Step output overrides used during example runs.

Response

Created dataset example.

One input/expected-output row in an automation dataset.

​
id
string
required

Stable public example id. Workflow examples use DB ids; agent examples use deterministic name-derived ids.

​
name
string
required

Human-readable dataset example name.

​
automationId
string
required

Automation that owns this example.

​
automationType
enum<string>
required
Available options:
workflow,
agent
​
input
object
required

Input arguments used when this example is run.

​
expected
any | null
required

Expected JSON output for evaluator comparisons.

​
expectedFiles
object[]
required

Expected files attached to this example.

​
metadata
object
required

Caller-managed metadata for sorting or filtering examples.

​
annotation
string | null
required

Human note about the example.

​
rowOrder
number | null
required

Optional display order within the dataset.

​
overrides
object
required

Step output overrides used when running this example.

​
latestRunId
string | null
required

Most recent run id created from this example.

​
createdAt
​
updatedAt