Getting Started
Observability
Search & Analytics
Prompt Templates
- GETList prompt template versions
- POSTCreate prompt template version by ID
- GETGet prompt template version by ID
- POSTGet bound prompt template version by ID
- DELDelete prompt template version
- POSTUpdate environment for prompt template version
- POSTCreate prompt template version by name
- GETList prompt templates
- POSTCreate prompt template
- GETGet all prompt templates by environment
- GETGet prompt template
- DELDelete prompt template
- PATCHUpdate prompt template
- GETGet prompt template by name and environment
- POSTGet bound prompt template by name and environment
Insights
Evaluation Criteria
- GETList Evaluation Criteria
- POSTCreate Evaluation Criteria
- GETList Code Evaluation Criteria
- POSTCreate Code Evaluation Criteria
- GETGet Code Evaluation Criteria
- DELDelete Code Evaluation Criteria
- PATCHUpdate Code Evaluation Criteria
- PATCHDisable Code Evaluation Criteria
- PATCHEnable Code Evaluation Criteria
- GETList Code Evaluation Criteria Versions
- POSTCreate Code Evaluation Criteria Version
- GETGet Code Evaluation Criteria Version
- POSTPublish Code Evaluation Criteria Version
- GETGet Evaluation Criteria
- DELDelete Evaluation Criteria
- PATCHDisable Criteria
- PATCHEnable Criteria
- PATCHReorder Criteria
- GETList Evaluation Criteria Versions
- POSTCreate Evaluation Criteria Version
- GETGet Evaluation Criteria Version
- DELDelete Evaluation Criteria Version
- POSTDeploy Evaluation Criteria Version
- POSTExecute Evals for Completion
- POSTExecute Evals for Trace
Prompt Datasets
- GETList Prompt Test Cases
- POSTUpload Prompt Test Cases
- GETList Prompt Test Cases by Dataset Name
- GETList Prompt Test Cases
- POSTBulk Create Prompt Test Cases
- DELBulk Delete Prompt Test Cases
- GETGet Prompt Test Case
- DELDelete Prompt Test Case
- PATCHUpdate Prompt Test Case
- GETGet Prompt Dataset
- GETGet Prompt Dataset by Name
- GETList Prompt Datasets
- POSTCreate Prompt-Level Dataset
- GETGet Prompt Dataset
- DELDelete Prompt Dataset
- PATCHUpdate Prompt Dataset
Agent Datasets
Configuration
- POSTCreate Project
- GETList Projects
- GETGet Project
- PUTUpdate Project
- DELDelete Project
- GETList Project Members
- POSTAdd Project Member
- DELRemove Project Member
- PATCHUpdate Project Member
- GETList Environments
- POSTCreate Environment
- DELDelete Environment
- PATCHUpdate Environment
- GETList Users
- POSTCreate User
- GETGet User
- DELDelete User
- PATCHUpdate User
Saved Searches
Prompt Optimization
Review Queues
Update Agent Dataset
curl --request PATCH \
--url https://api.example.com/api/v2/projects/{project_id}/agent-datasets/{dataset_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": null,
"description": null,
"compatible_agent_ids": null,
"tags": null
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"compatible_agent_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tags": null
}Agent Datasets
Update Agent Dataset
Modify an agent dataset’s name, description, or compatible agents. Use to evolve datasets as agent requirements change.
PATCH
/
api
/
v2
/
projects
/
{project_id}
/
agent-datasets
/
{dataset_id}
Update Agent Dataset
curl --request PATCH \
--url https://api.example.com/api/v2/projects/{project_id}/agent-datasets/{dataset_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": null,
"description": null,
"compatible_agent_ids": null,
"tags": null
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"compatible_agent_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tags": null
}Documentation Index
Fetch the complete documentation index at: https://docs.freeplay.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
200 - application/json
AgentDatasetResponse(id: uuid.UUID, name: str, description: Optional[str], compatible_agent_ids: list[uuid.UUID], tags: list[server.api_routes.agent_datasets_api_v2.TagResponse] = None)
⌘I