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

client.evals.runs.cancel(stringrunID, RunCancelParams { eval_id } params, RequestOptionsoptions?): RunCancelResponse { id, created_at, data_source, 11 more }

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

Create eval run

client.evals.runs.create(stringevalID, RunCreateParams { data_source, metadata, name } body, RequestOptionsoptions?): RunCreateResponse { id, created_at, data_source, 11 more }

POST/evals/{eval_id}/runs

Delete eval run

client.evals.runs.delete(stringrunID, RunDeleteParams { eval_id } params, RequestOptionsoptions?): RunDeleteResponse { deleted, object, run_id }

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

Get eval runs

client.evals.runs.list(stringevalID, RunListParams { after, limit, order, status } query?, RequestOptionsoptions?): CursorPage<RunListResponse { id, created_at, data_source, 11 more } >

GET/evals/{eval_id}/runs

Get an eval run

client.evals.runs.retrieve(stringrunID, RunRetrieveParams { eval_id } params, RequestOptionsoptions?): RunRetrieveResponse { id, created_at, data_source, 11 more }

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

ModelsExpand Collapse

CreateEvalCompletionsRunDataSource { source, type, input_messages, 2 more }

A CompletionsRunDataSource object describing a model sampling configuration.

CreateEvalJSONLRunDataSource { source, type }

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

EvalAPIError { code, message }

An object representing an error response from the Eval API.

RunCancelResponse { id, created_at, data_source, 11 more }

A schema representing an evaluation run.

RunCreateResponse { id, created_at, data_source, 11 more }

A schema representing an evaluation run.

RunDeleteResponse { deleted, object, run_id }

RunListResponse { id, created_at, data_source, 11 more }

A schema representing an evaluation run.

RunRetrieveResponse { id, created_at, data_source, 11 more }

A schema representing an evaluation run.

RunsOutput Items

Manage and run evals in the OpenAI platform.

Get eval run output items

client.evals.runs.outputItems.list(stringrunID, OutputItemListParams { eval_id, after, limit, 2 more } params, RequestOptionsoptions?): CursorPage<OutputItemListResponse { id, created_at, datasource_item, 7 more } >

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

Get an output item of an eval run

client.evals.runs.outputItems.retrieve(stringoutputItemID, OutputItemRetrieveParams { eval_id, run_id } params, RequestOptionsoptions?): OutputItemRetrieveResponse { id, created_at, datasource_item, 7 more }

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

ModelsExpand Collapse

OutputItemListResponse { id, created_at, datasource_item, 7 more }

A schema representing an evaluation run output item.

OutputItemRetrieveResponse { id, created_at, datasource_item, 7 more }

A schema representing an evaluation run output item.