Skip to main content
PATCH
Update Experiment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

experiment_id
string<uuid>
required

Path parameter for unique identifier of an experiment

Body

application/json

Request body for updating an experiment

name
string | null

Updated name of the experiment

Maximum string length: 256
description
string | null

Updated description of the experiment

Maximum string length: 512
metadata
object | null

JSONB field for unstructured metadata

Example:
status
enum<string>

Update experiment status

Available options:
IN_PROGRESS,
COMPLETED,
FAILED,
CANCELLED
Maximum string length: 64
error_reason
string | null

Error reason of the experiment

Maximum string length: 64
error_message
string | null

Error message of the experiment

traceback
string | null

Traceback of the experiment

Response

Updated experiment details

Response object for standard API responses.

api_version
enum<string>
default:3.0

API version.

Available options:
2.0,
3.0
kind
enum<string>
default:NORMAL

Type of response, indicating a normal response.

Available options:
NORMAL
data
object

Details of an experiment