Eigenpal Evaluation API

Manage datasets, examples, evaluators, experiment batches, evaluator scores, and run promotion workflows.

Documentation Provider Profile APIs.io OpenAPI GitHub

Eigenpal Evaluation API is one of 6 APIs that Eigenpal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Evaluation. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 29 operations across 18 paths, and defines 29 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://studio.eigenpal.com.

29 operations 18 paths 29 schemas 3 DELETE14 GET3 PATCH8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

1.0.0

Base URL

https://studio.eigenpal.com

Authentication

HTTP Bearer

Contact

Eigenpal

License

Apache-2.0

Resource Areas

Authentication & Security 1

Eigenpal Evaluation API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

bearerAuth — API key issued from Settings → API Keys. Pass as Authorization: Bearer .

Paths & Operations 29

Across 18 paths, the API surfaces 29 operations — 3 DELETE, 14 GET, 3 PATCH, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Evaluation 29

Manage datasets, examples, evaluators, experiment batches, evaluator scores, and run promotion workflows.

GET

/api/v1/automations/{id}/dataset/export

Export automation dataset

automations.dataset.export 2 params → 200400401403404413429500

POST

/api/v1/automations/{id}/dataset/import

Import automation dataset

automations.dataset.import 1 param body → 200400401403404413429500

GET

/api/v1/automations/{id}/evaluators

Get evaluators

automations.evaluators.get 1 param → 200400401403404413429500

PUT

/api/v1/automations/{id}/evaluators

Replace evaluators

automations.evaluators.update 1 param body → 200400401403404413429500

GET

/api/v1/automations/{id}/examples

List dataset examples

automations.examples.list 3 params → 200400401403404413429500

POST

/api/v1/automations/{id}/examples

Create dataset example

automations.examples.create 1 param body → 201400401403404413429500

GET

/api/v1/automations/{id}/examples/{exampleId}

Get dataset example

automations.examples.get 2 params → 200400401403404413429500

PATCH

/api/v1/automations/{id}/examples/{exampleId}

Update dataset example

automations.examples.update 2 params body → 200400401403404413429500

DELETE

/api/v1/automations/{id}/examples/{exampleId}

Delete dataset example

automations.examples.delete 2 params → 200400401403404413429500

GET

/api/v1/automations/{id}/examples/{exampleId}/expected

List expected files

automations.examples.expected.files.list 2 params → 200400401403404413429500

POST

/api/v1/automations/{id}/examples/{exampleId}/expected

Upload expected files

automations.examples.expected.files.create 2 params body → 201400401403404413429500

GET

/api/v1/automations/{id}/examples/{exampleId}/expected/{path}

Download expected dataset file

automations.examples.expected.file.get 3 params → 200400401403404413429500

PATCH

/api/v1/automations/{id}/examples/{exampleId}/expected/{path}

Rename expected file

automations.examples.expected.file.update 3 params body → 200400401403404413429500

DELETE

/api/v1/automations/{id}/examples/{exampleId}/expected/{path}

Delete expected file

automations.examples.expected.file.delete 3 params → 200400401403404413429500

GET

/api/v1/automations/{id}/examples/{exampleId}/input

List input files

automations.examples.input.files.list 2 params → 200400401403404413429500

POST

/api/v1/automations/{id}/examples/{exampleId}/input

Upload input files

automations.examples.input.files.create 2 params body → 201400401403404413429500

GET

/api/v1/automations/{id}/examples/{exampleId}/input/{path}

Download input file

automations.examples.input.file.get 3 params → 200400401403404413429500

PATCH

/api/v1/automations/{id}/examples/{exampleId}/input/{path}

Rename input file

automations.examples.input.file.update 3 params body → 200400401403404413429500

DELETE

/api/v1/automations/{id}/examples/{exampleId}/input/{path}

Delete input file

automations.examples.input.file.delete 3 params → 200400401403404413429500

POST

/api/v1/automations/{id}/examples/{exampleId}/run

Run dataset example

automations.examples.run 2 params → 201400401403404413429500

GET

/api/v1/automations/{id}/experiments

List experiments

automations.experiments.list 5 params → 200400401403404413429500

POST

/api/v1/automations/{id}/experiments

Create experiment

automations.experiments.create 1 param body → 202400401403404413429500

GET

/api/v1/automations/{id}/experiments/{experimentId}

Get experiment

automations.experiments.get 2 params → 200400401403404413429500

POST

/api/v1/automations/{id}/experiments/{experimentId}/cancel

Cancel experiment

automations.experiments.cancel 2 params → 200400401403404413429500

GET

/api/v1/automations/{id}/experiments/{experimentId}/export

Export experiment eval results

automations.experiments.export 4 params → 200400401403404413429500

GET

/api/v1/automations/{id}/experiments/export

Export all experiment eval results

automations.experiments.exportAll 2 params → 200400401403404413429500

POST

/api/v1/automations/{id}/experiments/stream

Create automation experiment with NDJSON progress

automations.experiments.createStream 1 param body → 200400401403404413429500

GET

/api/v1/experiments/{experimentId}

Resolve experiment by id

experiments.resolve 1 param → 200400401403404413429500

GET

/api/v1/runs/{id}/scores

List run evaluator scores

runs.scores.list 1 param → 200400401403404413429500

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are DatasetExample (14 properties), ExperimentDetail (14 properties), EvalResult (14 properties), Experiment (12 properties). Each schema is shown below with its type and property counts.

DatasetExampleExpectedFileRenameRequest

object

1 property 1 required

DatasetExampleUpdate

object

Partial update for a dataset example. Omitted fields are preserved.

7 properties

Experiment

object

Experiment batch summary for an automation dataset run.

12 properties 12 required

DatasetExampleInputFileUploadRequest

object

1 property 1 required

DatasetExampleExpectedFileUploadRequest

object

1 property 1 required

DatasetExampleList

object

4 properties 4 required

AutomationDatasetImportMultipartRequest

object

2 properties 1 required

DatasetExampleExpectedFileRenameResponse

object

3 properties 3 required

ExperimentCreateResponse

object

Accepted experiment batch and the runs it enqueued.

3 properties 3 required

DatasetExampleInputFileUploadResponse

object

1 property 1 required

DatasetExampleInputFileRenameRequest

object

1 property 1 required

ExperimentRef

object

2 properties 2 required

DatasetImportResponse

ExperimentCreate

object

Request body for starting an experiment batch.

3 properties

RunScoresResponse

object

Automated evaluator results attached to a run.

1 property 1 required

DatasetExampleMutation

object

Fields used to create or update a dataset example.

7 properties

DatasetExampleInputFileRenameResponse

object

3 properties 3 required

DatasetExample

object

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

14 properties 12 required

DatasetExampleInputFileList

object

1 property 1 required

ExperimentDetail

object

Experiment batch detail.

14 properties 14 required

EvalResult

object

Automated evaluator result for one run.

14 properties 14 required

DatasetExampleExpectedFileUploadResponse

object

1 property 1 required

EvaluatorConfigResponse

object

Evaluator YAML and parsed evaluator configuration for an automation.

4 properties 4 required

ApiErrorEnvelope

object

4 properties 2 required

EvaluatorConfigUpdate

object

Replacement evaluator configuration.

1 property 1 required

DatasetExampleExpectedFileList

object

1 property 1 required

ExampleRunResponse

object

4 properties 4 required

ApiErrorIssue

object

4 properties 4 required

AutomationType

string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Eigenpal publishes across the network.

Eigenpal Automations API

AE Profile APIs.io

Eigenpal Files API

AE Profile APIs.io

Eigenpal Metadata API

AE Profile APIs.io

Eigenpal Reviews API

AE Profile APIs.io

Eigenpal Runs API

AE Profile APIs.io

#Evaluation

← Back to E APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Eigenpal Evaluation API

Metadata

Authentication & Security 1

Paths & Operations 29

Schemas 29

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Eigenpal Evaluation API

Metadata

Authentication & Security 1

Paths & Operations 29

Schemas 29

Specification

Source

More from Eigenpal 5

API Details

Provider

Explore more