API ReferenceExperiments

Api V 2 Experiments Create 2

POST handler with superadmin-only field protection.

Strips superadmin-only fields from non-superadmin requests before delegating to OrganizationInjectionMixin.post() for org injection.

Authentication

AuthorizationBearer
JWT access token or Respan API key

Path parameters

experiment_idstringRequired

Request

This endpoint expects an object.
projectstring or nullOptional>=1 character
namestringOptional<=255 characters
descriptionstringOptional
workflowanyOptional
workflow_countintegerOptional-2147483648-2147483647
evaluator_slugslist of stringsOptional
List of evaluators to run for producing scores for comparison
evaluator_workflow_idslist of stringsOptional

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

resource_idslist of stringsOptional

All resource IDs referenced (evaluators, prompts) for reverse lookup on deletion

batch_sizeintegerOptional-2147483648-2147483647
concurrencyintegerOptional-2147483648-2147483647
enable_tracingbooleanOptional
statusenumOptional
  • draft - Draft
  • pending - Pending
  • paused - Paused
  • running - Running
  • waiting_for_annotations - Waiting For Annotations
  • completed - Completed
  • failed - Failed
progressdoubleOptional
metadataanyOptional
is_starredbooleanOptional
started_atdatetime or nullOptional
completed_atdatetime or nullOptional
datasetstring or nullOptional>=1 character
task_trackerstring or nullOptional>=1 character

Response

idstringRead-only
evaluator_idsstringRead-only
unique_organization_idstringRead-only
created_atdatetimeRead-only
updated_atdatetimeRead-only
organizationintegerRead-only
created_byinteger or nullRead-only
projectstring or null
namestring<=255 characters
descriptionstring
workflowany
workflow_countinteger-2147483648-2147483647
evaluator_slugslist of strings
List of evaluators to run for producing scores for comparison
evaluator_workflow_idslist of strings

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

resource_idslist of strings

All resource IDs referenced (evaluators, prompts) for reverse lookup on deletion

batch_sizeinteger-2147483648-2147483647
concurrencyinteger-2147483648-2147483647
enable_tracingboolean
statusenum
  • draft - Draft
  • pending - Pending
  • paused - Paused
  • running - Running
  • waiting_for_annotations - Waiting For Annotations
  • completed - Completed
  • failed - Failed
progressdouble
metadataany
is_starredboolean
started_atdatetime or null
completed_atdatetime or null
datasetstring or null
task_trackerstring or null