Get Evals List

Retrieves a list of evaluations for a given dataset, with options for filtering and ordering.

Get Evals List

Retrieves a list of evaluations available for a given dataset, including built-in and user-created evals, with support for filtering by category, type, tags, and use cases.

GET https://api.futureagi.com/model-hub/develops/{dataset_id}/get_evals_list/

Authentication

All requests require authentication via API keys:

HeaderDescription
X-Api-KeyYour API key
X-Secret-KeyYour secret key

Parameters

Path Parameters

ParameterTypeRequiredDescription
dataset_idstring (UUID)YesUUID of the dataset to retrieve evaluations for.

Query Parameters

ParameterTypeRequiredDescription
search_textstringNoText to filter evaluation names. Case-insensitive.
eval_categoriesstringNoFilter by category. One of: futureagi_built, user_built.
eval_typestringNoFilter by type. One of: preset, user, previously_configured.
eval_tags[]arrayNoFilter by one or more eval tags.
use_cases[]arrayNoFilter by one or more use cases.
experiment_idstring (UUID)NoUUID of an experiment to scope results to.
orderstringNoOrdering mode. Use simulate for simulation-specific ordering.

Responses

200

A list of evaluations and recommendations.

  • evals: array of evaluation objects with id, name, description, and tags.
  • eval_recommendations: array of string — recommended evaluation categories.

400

Bad request. Possible reasons:

  • Missing dataset IDdataset_id path parameter is required.
  • Experiment not found — The specified experiment_id does not exist.

401

Unauthorized. Invalid or missing API credentials.

404

Not Found. The requested dataset does not exist.

500

Internal Server Error. An unexpected error occurred while fetching the evaluations list.

Code Examples

import requests

dataset_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
url = f"https://api.futureagi.com/model-hub/develops/{dataset_id}/get_evals_list/"
headers = {
    "X-Api-Key": "YOUR_API_KEY",
    "X-Secret-Key": "YOUR_SECRET_KEY",
    "Content-Type": "application/json"
}
params = {
    "search_text": "hallucination",
    "eval_categories": "futureagi_built"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
const datasetId = "a1b2c3d4-e5f6-7890-abcd-ef1234567890";
const params = new URLSearchParams({
  search_text: "hallucination",
  eval_categories: "futureagi_built"
});

const response = await fetch(
  `https://api.futureagi.com/model-hub/develops/${datasetId}/get_evals_list/?${params}`,
  {
    method: "GET",
    headers: {
      "X-Api-Key": "YOUR_API_KEY",
      "X-Secret-Key": "YOUR_SECRET_KEY",
      "Content-Type": "application/json"
    }
  }
);

const data = await response.json();
console.log(data);
curl -X GET "https://api.futureagi.com/model-hub/develops/a1b2c3d4-e5f6-7890-abcd-ef1234567890/get_evals_list/?search_text=hallucination&eval_categories=futureagi_built" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "X-Secret-Key: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json"
GET /
Authentication
REQUEST
 
RESPONSE