Update an experiment | Respan Docs

Partially update editable fields for an experiment.

Path parameters

experiment_idstringRequired

Experiment ID returned as id in experiment responses.

Request

Update editable experiment fields. evaluator_ids is accepted as an alias for evaluator_slugs.

dataset_idstringOptional

Dataset ID to process.

workflowlist of objectsOptional

Workflow tasks to run for each dataset row.

evaluator_idslist of stringsOptional

Preferred evaluator identifiers for scoring. Mutually exclusive with evaluator_workflow_ids.

evaluator_slugslist of stringsOptional

Backward-compatible alias for evaluator_ids. If both are provided, evaluator_ids takes precedence.

evaluator_workflow_idslist of stringsOptional

WorkflowVersion IDs configured for eval-only scoring. Mutually exclusive with evaluator IDs/slugs.

experiment_idstringOptional

Optional client-provided experiment ID. The backend generates one when omitted.

namestringOptional

Experiment name.

descriptionstringOptional

Experiment description.

span_workflow_namestringOptionalDefaults to workflow

Root workflow span name.

enable_tracingbooleanOptionalDefaults to true

Whether to create trace logs.

batch_sizeintegerOptionalDefaults to 100

Batch size for processing.

concurrencyintegerOptionalDefaults to 15

Number of concurrent workers.

generation_methodstringOptional

Optional evaluation generation method override.

Response

Updated experiment.

idstring

Experiment ID.

namestring

Experiment name.

statusstring

Experiment execution status.

created_atdatetime

descriptionstring or null

Experiment description.

datasetstring or null

Dataset ID associated with the experiment.

dataset_idstring or null

Dataset ID associated with the experiment.

dataset_namestring or null

Dataset name, when available.

workflow_countinteger

Number of workflow steps.

progressdouble

Execution progress percentage.

started_atdatetime or null

completed_atdatetime or null

tagslist of maps from strings to any

Tags attached to the experiment.

workflowlist of objects

Workflow tasks configured for the experiment.

evaluator_idslist of strings

Evaluator IDs used for scoring.

evaluator_slugslist of strings

Backward-compatible evaluator identifiers stored by the backend.

evaluator_workflow_idslist of strings

Eval-only workflow versions used for scoring.

batch_sizeinteger

concurrencyinteger

enable_tracingboolean

error_messagestring or null

Failure details when status is failed.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

1	curl -X PATCH https://api.respan.ai/api/v2/experiments/experiment_id/ \
2	-H "Authorization: Bearer sk_live_xxxxx" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"dataset_id": "ds_supportqa_2024",
6	"workflow": [
7	{
8	"type": "completion",
9	"config": {
10	"model": "gpt-4o-mini",
11	"temperature": 0.2,
12	"max_tokens": 256
13	}
14	}
15	],
16	"evaluator_ids": [
17	"eval_quality"
18	],
19	"name": "gpt-4o-mini quality run",
20	"concurrency": 15
21	}'

1	{
2	"id": "exp_supportqa_001",
3	"name": "gpt-4o-mini quality run",
4	"status": "pending",
5	"created_at": "2024-01-15T09:30:00Z",
6	"description": "Evaluation run for GPT-4o-mini model on Support QA dataset to measure response quality.",
7	"dataset": "ds_supportqa_2024",
8	"dataset_id": "ds_supportqa_2024",
9	"dataset_name": "Support QA Dataset",
10	"workflow_count": 1,
11	"progress": 0,
12	"started_at": "2024-01-15T09:30:00Z",
13	"completed_at": "2024-01-15T09:30:00Z",
14	"tags": [
15	{}
16	],
17	"workflow": [
18	{
19	"type": "completion",
20	"config": {
21	"model": "gpt-4o-mini",
22	"temperature": 0.2,
23	"max_tokens": 256
24	}
25	}
26	],
27	"evaluator_ids": [
28	"eval_quality"
29	],
30	"evaluator_slugs": [
31	"eval_quality"
32	],
33	"evaluator_workflow_ids": [
34	"wfv_supportqa_001"
35	],
36	"batch_size": 100,
37	"concurrency": 15,
38	"enable_tracing": true,
39	"error_message": ""
40	}

Path parameters

Headers

Request

Response

Errors