Llm
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
GET | |
POST | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
POST | |
GET | |
POST | |
GET |
Retrieve environments llm analytics clustering config
Team-level clustering configuration (event filters for automated pipelines).
Required API key scopes
llm_analytics:readExample request
GET /api /environments /:environment_id /llm_analytics /clustering_configExample response
Status 200
Create environments llm analytics clustering config set event filters
Team-level clustering configuration (event filters for automated pipelines).
Required API key scopes
llm_analytics:writeExample request
POST /api /environments /:environment_id /llm_analytics /clustering_config /set_event_filtersExample response
Status 200
List all environments llm analytics clustering jobs
CRUD for clustering job configurations (max 5 per team).
Required API key scopes
llm_analytics:readQuery parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /environments /:environment_id /llm_analytics /clustering_jobsExample response
Status 200
Create environments llm analytics clustering jobs
CRUD for clustering job configurations (max 5 per team).
Required API key scopes
llm_analytics:writeRequest parameters
- namestring
- analysis_level
- event_filters
- enabledboolean
Response
Example request
POST /api /environments /:environment_id /llm_analytics /clustering_jobsExample response
Status 201
Retrieve environments llm analytics clustering jobs
CRUD for clustering job configurations (max 5 per team).
Required API key scopes
llm_analytics:readPath parameters
- idstring
Response
Example request
GET /api /environments /:environment_id /llm_analytics /clustering_jobs /:idExample response
Status 200
Update environments llm analytics clustering jobs
CRUD for clustering job configurations (max 5 per team).
Required API key scopes
llm_analytics:writePath parameters
- idstring
Request parameters
- namestring
- analysis_level
- event_filters
- enabledboolean
Response
Example request
PATCH /api /environments /:environment_id /llm_analytics /clustering_jobs /:idExample response
Status 200
Delete environments llm analytics clustering jobs
CRUD for clustering job configurations (max 5 per team).
Required API key scopes
llm_analytics:writePath parameters
- idstring
Example request
DELETE /api /environments /:environment_id /llm_analytics /clustering_jobs /:idExample response
Status 204 No response body
Retrieve environments llm analytics evaluation config
Get the evaluation config for this team
Required API key scopes
evaluation:readResponse
Example request
GET /api /environments /:environment_id /llm_analytics /evaluation_configExample response
Status 200
Create environments llm analytics evaluation config set active key
Set the active provider key for evaluations
Required API key scopes
evaluation:writeRequest parameters
- key_idstring
Response
Example request
POST /api /environments /:environment_id /llm_analytics /evaluation_config /set_active_keyExample response
Status 200
List all environments llm analytics evaluation reports
CRUD for evaluation report configurations + report run history.
Required API key scopes
llm_analytics:readQuery parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /environments /:environment_id /llm_analytics /evaluation_reportsExample response
Status 200
Create environments llm analytics evaluation reports
CRUD for evaluation report configurations + report run history.
Required API key scopes
llm_analytics:writeRequest parameters
- evaluationstring
- frequency
- rrulestring
- starts_atstringnull
- timezone_namestring
- delivery_targets
- max_sample_sizeinteger
- enabledboolean
- deletedboolean
- report_prompt_guidancestring
- trigger_thresholdintegernull
- cooldown_minutesinteger
- daily_run_capinteger
Response
Example request
POST /api /environments /:environment_id /llm_analytics /evaluation_reportsExample response
Status 201
Retrieve environments llm analytics evaluation reports
CRUD for evaluation report configurations + report run history.
Required API key scopes
llm_analytics:readPath parameters
- idstring
Response
Example request
GET /api /environments /:environment_id /llm_analytics /evaluation_reports /:idExample response
Status 200
Update environments llm analytics evaluation reports
CRUD for evaluation report configurations + report run history.
Required API key scopes
llm_analytics:writePath parameters
- idstring
Request parameters
- evaluationstring
- frequency
- rrulestring
- starts_atstringnull
- timezone_namestring
- delivery_targets
- max_sample_sizeinteger
- enabledboolean
- deletedboolean
- report_prompt_guidancestring
- trigger_thresholdintegernull
- cooldown_minutesinteger
- daily_run_capinteger
Response
Example request
PATCH /api /environments /:environment_id /llm_analytics /evaluation_reports /:idExample response
Status 200
Delete environments llm analytics evaluation reports
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
llm_analytics:writePath parameters
- idstring
Example request
DELETE /api /environments /:environment_id /llm_analytics /evaluation_reports /:idExample response
Status 405 No response body
Create environments llm analytics evaluation reports generate
Trigger immediate report generation.
Required API key scopes
llm_analytics:writePath parameters
- idstring
Example request
POST /api /environments /:environment_id /llm_analytics /evaluation_reports /:id /generateExample response
Status 202 No response body
List all environments llm analytics evaluation reports runs
List report runs (history) for this report.
Required API key scopes
llm_analytics:readPath parameters
- idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /environments /:environment_id /llm_analytics /evaluation_reports /:id /runsExample response
Status 200
Create environments llm analytics evaluation summary
Generate an AI-powered summary of evaluation results.
This endpoint analyzes evaluation runs and identifies patterns in passing and failing evaluations, providing actionable recommendations.
Data is fetched server-side by evaluation ID to ensure data integrity.
Use Cases:
- Understand why evaluations are passing or failing
- Identify systematic issues in LLM responses
- Get recommendations for improving response quality
- Review patterns across many evaluation runs at once
Required API key scopes
llm_analytics:writeRequest parameters
- evaluation_idstring
- filterDefault:
all - generation_idsarray
- force_refreshbooleanDefault:
false
Response
Example request
POST /api /environments /:environment_id /llm_analytics /evaluation_summaryExample response
Status 200
Status 400
Status 403
Status 404
Status 500
Retrieve environments llm analytics models
List available models for a provider.
Required API key scopes
evaluation:readQuery parameters
- key_idstring
- providerstringOne of:
"anthropic""azure_openai""fireworks""gemini""openai""openrouter""together_ai"
Response
Example request
GET /api /environments /:environment_id /llm_analytics /models