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

evals.runs.cancel(strrun_id, RunCancelParams**kwargs) -> RunCancelResponse

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

Create eval run

evals.runs.create(streval_id, RunCreateParams**kwargs) -> RunCreateResponse

POST/evals/{eval_id}/runs

Delete eval run

evals.runs.delete(strrun_id, RunDeleteParams**kwargs) -> RunDeleteResponse

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

Get eval runs

evals.runs.list(streval_id, RunListParams**kwargs) -> SyncCursorPage[RunListResponse]

GET/evals/{eval_id}/runs

Get an eval run

evals.runs.retrieve(strrun_id, RunRetrieveParams**kwargs) -> RunRetrieveResponse

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.

class RunCancelResponse: …

A schema representing an evaluation run.

class RunCreateResponse: …

A schema representing an evaluation run.

class RunDeleteResponse: …

class RunListResponse: …

A schema representing an evaluation run.

class RunRetrieveResponse: …

A schema representing an evaluation run.

RunsOutput Items

Manage and run evals in the OpenAI platform.

Get eval run output items

evals.runs.output_items.list(strrun_id, OutputItemListParams**kwargs) -> SyncCursorPage[OutputItemListResponse]

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

Get an output item of an eval run

evals.runs.output_items.retrieve(stroutput_item_id, OutputItemRetrieveParams**kwargs) -> OutputItemRetrieveResponse

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

ModelsExpand Collapse

class OutputItemListResponse: …

A schema representing an evaluation run output item.

class OutputItemRetrieveResponse: …

A schema representing an evaluation run output item.