reports

Run Full Evaluation

post/reports/{report_id}/run

Request

Base URL
https://docs.promptlayer.com (the document declares no server; this is the origin it was published from)
Auth
API key in header X-API-KEY
TypeScript
https://skmtc.dev/promptlayer/apis/promptlayer-api/docs/reports/:report_id/run/post.ts
A function with typed inputs. Its response is checked against the schema.

report_idinteger required

ID of the evaluation pipeline report to run.

namestring required

The name of the final report to be created. Must be between 1 and 255 characters in length.

dataset_idinteger nullable

The ID of the dataset to use for the report. If not provided, uses the evaluation pipeline's default dataset.

refresh_datasetboolean nullable

Whether to refresh the dataset before running the report. Only applicable for dynamic datasets.

Report run initiated successfully

successboolean required

report_idinteger required

The ID of the created final report.

No recorded changes to this operation across all 3 revisions of this API.