API Reference

Evals

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Runs

Manage and run evals in the OpenAI platform.

Cancel eval run

RunCancelResponse evals().runs().cancel(RunCancelParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/evals/{eval_id}/runs/{run_id}

Create eval run

RunCreateResponse evals().runs().create(RunCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/evals/{eval_id}/runs

Delete eval run

RunDeleteResponse evals().runs().delete(RunDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

DELETE/evals/{eval_id}/runs/{run_id}

Get eval runs

RunListPage evals().runs().list(RunListParamsparams = RunListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/evals/{eval_id}/runs

Get an eval run

RunRetrieveResponse evals().runs().retrieve(RunRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/evals/{eval_id}/runs/{run_id}

ModelsExpand Collapse

class CreateEvalCompletionsRunDataSource:

A CompletionsRunDataSource object describing a model sampling configuration.

class CreateEvalJsonlRunDataSource:

A JsonlRunDataSource object with that specifies a JSONL file that matches the eval

class EvalApiError:

An object representing an error response from the Eval API.

RunsOutput Items

Manage and run evals in the OpenAI platform.

Get eval run output items

OutputItemListPage evals().runs().outputItems().list(OutputItemListParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/evals/{eval_id}/runs/{run_id}/output_items

Get an output item of an eval run

OutputItemRetrieveResponse evals().runs().outputItems().retrieve(OutputItemRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}