Edit and Run Dataset Eval — API

Update an evaluation's config and key mapping, then optionally re-run it across all dataset rows to refresh scores.

POST https://api.futureagi.com/model-hub/develops/{dataset_id}/edit_and_run_user_eval/{eval_id}/

Authentication

X-Api-Key API Key Required

Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the Dashboard under Settings.

X-Secret-Key Secret Key Required

Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the Dashboard.

Path parameters

dataset_id UUID Required

UUID of the dataset containing the evaluation to edit.

eval_id UUID Required

UUID of the user eval metric to update.

Request body

config object Required

Updated configuration object for the evaluation.

config object

Template-specific configuration parameters.

params object

Runtime parameters for the evaluation engine.

mapping object

Mapping of eval template variable keys to dataset column names.

reason_column boolean

Whether to create or keep a reason column alongside the eval result column.

kb_id string Optional

UUID of a knowledge base to associate with this evaluation.

error_localizer boolean Optional

Whether to enable error localization for this evaluation.

model string Optional
Model to use for running the evaluation.
run boolean Optional

Whether to re-run the evaluation after updating its configuration.

save_as_template boolean Optional

Whether to save the updated configuration as a new eval template.

name string Optional

Name for the new eval template. Required when save_as_template is true.

experiment_id string Optional

UUID of an experiment. When provided the evaluation is looked up by experiment scope rather than dataset scope, and reason columns are reconciled across all experiment data tables.

Response

200 OK
data string

Confirmation message indicating the evaluation was updated.

success boolean
Whether the request completed successfully.

Errors

400 Bad Request Optional
Invalid request parameters.
401 Unauthorized Optional
Invalid or missing API credentials.
404 Not Found Optional
The specified evaluation was not found.
500 Internal Server Error Optional
Unexpected server error.
GET /
Authentication
REQUEST 
 
 
  
 
 RESPONSE