Skip to main content
GET
/
api
/
v1
/
automations
/
{id}
/
examples
/
{exampleId}
Get automation example
curl --request GET \
  --url https://studio.eigenpal.com/api/v1/automations/{id}/examples/{exampleId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "automationId": "<string>",
  "input": {},
  "expected": null,
  "expectedFiles": [
    {
      "name": "<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
​
exampleId
string
required

Response

Example

​
id
string
required

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

​
name
string
required
​
automationId
string
required
​
automationType
enum<string>
required
Available options:
workflow,
agent
​
input
object
required
​
expected
unknown
required
​
expectedFiles
object[]
required
​
metadata
object
required
​
annotation
string | null
required
​
rowOrder
number | null
required
​
overrides
object
required
​
latestRunId
string | null
required
​
createdAt
​
updatedAt