Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Eigenpal

Eigenpal Reviews API

Record human review verdicts, manage corrected outputs, and monitor review health.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 10 operations across 5 paths, and defines 20 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.

10 operations 5 paths 20 schemas 2 DELETE4 GET1 PATCH2 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
1

Authentication & Security 1

Eigenpal Reviews 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 10

Across 5 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Reviews 10

Record human review verdicts, manage corrected outputs, and monitor review health.

GET
/api/v1/automations/{id}/reviews/health
Get automation review health
automations.reviews.health 17 params → 200400401403404413429500
POST
/api/v1/runs/{id}/promote
Promote run to example
runs.promote 1 param body → 200400401403404413429500
GET
/api/v1/runs/{id}/reviews
Get run review
runs.reviews.get 1 param → 200400401403404413429500
PUT
/api/v1/runs/{id}/reviews
Update run review
runs.reviews.update 1 param body → 200400401403404413429500
DELETE
/api/v1/runs/{id}/reviews
Clear run review
runs.reviews.clear 1 param → 200400401403404413429500
GET
/api/v1/runs/{id}/reviews/expected
List corrected files
runs.reviews.expected.get 1 param → 200400401403404413429500
POST
/api/v1/runs/{id}/reviews/expected
Add corrected file
runs.reviews.expected.create 1 param body → 201400401403404413429500
GET
/api/v1/runs/{id}/reviews/expected/{filename}
Download corrected artifact file
runs.reviews.expected.file.get 2 params → 200400401403404413429500
PATCH
/api/v1/runs/{id}/reviews/expected/{filename}
Rename corrected artifact file
runs.reviews.expected.file.update 2 params body → 200400401403404413429500
DELETE
/api/v1/runs/{id}/reviews/expected/{filename}
Delete corrected artifact file
runs.reviews.expected.file.delete 2 params → 204400401403404413429500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are RunReview (15 properties), RunReviewCorrection (10 properties), RunReviewHealthBucket (9 properties), RunReviewHealthSummary (8 properties). Each schema is shown below with its type and property counts.

RunReviewHealthBucket
object
9 properties 9 required
PromoteRunResponse
object
4 properties 4 required
RunReviewHealthSummary
object
8 properties 8 required
RunReviewHealthResponse
object
5 properties 5 required
RunReviewExpectedFileCopyRequest
object
JSON request body for copying one run output file into the corrected artifact set.
2 properties 1 required
RunReview
object
15 properties 14 required
RunReviewExpectedFileMutationResponse
Corrected file created or renamed by the request.
RunReviewHealthRollingPoint
object
8 properties 8 required
RunReviewHealthConfidence
object
Wilson score confidence interval for reviewed correctness. Null bounds mean there are no reviewed runs in the sample.
3 properties 3 required
RunReviewExpectedArtifacts
object
1 property 1 required
RunReviewExpectedFileUpdateRequest
object
Rename one corrected file.
1 property 1 required
PromoteRunRequest
object
Create or update a dataset example from the run input, actual output, and review corrections.
1 property
RunFile
object
1 property 1 required
RunReviewExpectedFileUploadRequest
object
2 properties 1 required
RunReviewDetail
object
1 property 1 required
RunReviewExpectedFileUpdateResponse
Corrected file after the rename.
ApiErrorEnvelope
object
4 properties 2 required
RunReviewCorrection
object
10 properties 7 required
ApiErrorIssue
object
4 properties 4 required
RunReviewRequest
object
Create or replace review metadata for a run. Attribution fields (reviewedBy, closedBy, and their emails) are read-only and populated from the authenticated use…
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

eigenpal-reviews-api-openapi.yml Raw ↑

Other APIs Eigenpal publishes across the network.

Eigenpal Automations API
AE Profile APIs.io
Eigenpal Evaluation API
AE Profile APIs.io
Eigenpal Files API
AE Profile APIs.io
Eigenpal Metadata API
AE Profile APIs.io
Eigenpal Runs API
AE Profile APIs.io
#Reviews
← Back to E APIs
API Details
ID
eigenpal:eigenpal-reviews-api
Base URL
https://studio.eigenpal.com
Docs
https://docs.eigenpal.com/api-reference
Provider
Eigenpal
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network