Skip to navigation

Get an eval run

View as Markdown

Poll this. Fetch the report when lifecycle.report.status is REPORT_STATUS_AVAILABLE. The run is fully finished when lifecycle.status is terminal and lifecycle.cleanup.status is CLEANUP_STATUS_SUCCEEDED or CLEANUP_STATUS_FAILED. Visible to the credential’s user that created the run and to the eval admins Moveworks designates for the org; any other id answers 404.

Authentication

AuthorizationBearer

OAuth 2.0 client-credentials bearer from POST /oauth/v1/token (same as the Conversations API). The token is issued to one org and bound to one user; the run executes in that org and its conversations run as that user. If the eval config names a source_org, it must be the same org. An org that is not enabled for the Eval API sees 404 NOT_FOUND (“API not found”) on every route. An enabled org whose credential is not entitled to run evals receives 403 REQUEST_ACCESS_DENIED. submitted_by.email_addr is the email of the user the credential is bound to.

Path parameters

eval_run_idstringRequired
The run id returned by the submit call.

Response

The run.
metadataobject

What a run is, fixed when the submission is accepted; a validate_only preview carries it without id.

lifecycleobjectOptional

What moves while the run executes; absent on a validate_only preview.

warningslist of objectsOptional

Non-blocking findings about the run, the twin of the validation issues[]. Absent when there are none, never null, never changes lifecycle.status. Carried on the create (202, or 200 on a validate_only dry run) and on the get, list and cancel responses; findings a pipeline step records later are merged in on later reads.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error