Skip to main content
PATCH
/
api
/
experiments
/
{experiment_id}
{
  "name": "Updated Experiment Name",
  "description": "Updated description"
}

{
  "id": "experiment_id_123",
  "name": "Updated Experiment Name"
}
Update an experiment’s metadata.

​
Authentication

  • API key: Authorization: Bearer <API key>

​
Path Parameters

​
experiment_id
string
required
The ID of the experiment to update.

​
Request Body

{
  "name": "Updated Experiment Name",
  "description": "Updated description"
}

​
Examples

import requests

experiment_id = "experiment_id_123"
url = f"https://api.keywordsai.co/api/experiments/{experiment_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

data = {
    "name": "Updated Experiment Name"
}

response = requests.patch(url, headers=headers, json=data)
print(response.json())

​
Response

{
  "id": "experiment_id_123",
  "name": "Updated Experiment Name"
}