Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Runs

Manage and run evals in the OpenAI platform.

Cancel eval run
client.evals.runs.cancel(runID, params, options?): RunCancelResponse { id, created_at, data_source, 11 more }
POST
/evals/{eval_id}/runs/{run_id}/cancel
Create eval run
client.evals.runs.create(evalID, body, options?): RunCreateResponse { id, created_at, data_source, 11 more }
POST
/evals/{eval_id}/runs
Delete eval run
client.evals.runs.delete(runID, params, options?): RunDeleteResponse { deleted, object, run_id }
DELETE
/evals/{eval_id}/runs/{run_id}
Get eval runs
client.evals.runs.list(evalID, query?, options?): CursorPage<RunListResponse { id, created_at, data_source, 11 more } >
GET
/evals/{eval_id}/runs
Get an eval run
client.evals.runs.retrieve(runID, params, options?): RunRetrieveResponse { id, created_at, data_source, 11 more }
GET
/evals/{eval_id}/runs/{run_id}
Models
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(runID, params, options?): 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(outputItemID, params, options?): OutputItemRetrieveResponse { id, created_at, datasource_item, 7 more }
GET
/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}
Models
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.