v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
experiments

Update Experiment

PATCH handler with superadmin lock and field protection.

Checks:

  1. Object lock (is_managed=True -> non-superadmins can't modify)
  2. Field protection (non-superadmins can't modify specific fields)
patch/api/v2/experiments/{experiment_id}/

Path parameters

experiment_idstring required

Headers

Authorizationstring required

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

Request body

namestring
descriptionstring
datasetstring nullable
{"stackTrail":"components:schemas:PatchedExperimentV2UpdateRequest:properties:workflow","oasType":"schema","type":"unknown","description":"Any type"}
evaluator_slugsstring[]

List of evaluators to run for producing scores for comparison

evaluator_workflow_idsstring[]

List of WorkflowVersion IDs (eval_only) defining evaluator pipelines. Mutually exclusive with evaluator_slugs.

batch_sizeinteger
concurrencyinteger
enable_tracingboolean
is_starredboolean

Response

namestring
descriptionstring
datasetstring nullable
{"stackTrail":"components:schemas:ExperimentV2Update:properties:workflow","oasType":"schema","type":"unknown","description":"Any type"}
evaluator_slugsstring[]

List of evaluators to run for producing scores for comparison

evaluator_workflow_idsstring[]

List of WorkflowVersion IDs (eval_only) defining evaluator pipelines. Mutually exclusive with evaluator_slugs.

batch_sizeinteger
concurrencyinteger
enable_tracingboolean
is_starredboolean