> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/stackai-api/rest-api-v2/experiments-and-jobs/patch-v2-evals-experiments-experiment_id.md).

# PATCH /v2/evals/experiments/{experiment\_id}

## Update Eval Experiment

> Update metadata; omitted fields remain unchanged and null clears notes.\
> \
> \*\*How to use\*\*\
> \
> Update metadata only as permitted by the request schema. Omitted fields stay unchanged; null clears notes. This is not a replacement for creating a new experiment snapshot.\
> \
> \*\*Authentication and permissions\*\*\
> \
> Required permissions: \`evals.update\`. Resource and owner access checks also apply.\
> \
> \*\*Prepare request.json\*\*\
> \
> Save the example body below as \`request.json\` for the curl sample. Replace example IDs, node keys, and dynamic configuration with values for your organization; these are illustrative, not pre-existing resources.\
> \
> \`\`\`json\
> {\
> &#x20; "notes": "Reviewed regression run"\
> }\
> \`\`\`

````json
{"openapi":"3.1.0","info":{"title":"StackAI API","version":"0.1.0"},"tags":[{"name":"endpoint-updateEvalExperimentV2"}],"servers":[{"url":"https://api.stack-ai.com","description":"Hosted API. Use your deployment-specific origin for private installations."}],"security":[{"HTTPBearer":[]}],"components":{"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer","description":"Personal API key (sk_...) or supported user access JWT. See Authentication and authorization for endpoint restrictions and scopes. Use exactly one Authorization header."}},"schemas":{"EvalExperimentUpdateRequestV2":{"properties":{"name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Name"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"additionalProperties":false,"type":"object","title":"EvalExperimentUpdateRequest"},"StackAIAPIDataResponse_EvalExperimentResponseV2_":{"properties":{"response_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Code","description":"Machine-readable response code, when provided."},"meta":{"additionalProperties":true,"type":"object","title":"Meta","description":"Additional metadata","default":{}},"data":{"$ref":"#/components/schemas/EvalExperimentResponseV2","description":"Data returned by the API service"}},"type":"object","required":["data"],"title":"StackAIAPIDataResponse[EvalExperimentResponseV2]"},"EvalExperimentResponseV2":{"properties":{"experiment_id":{"type":"string","format":"uuid","title":"Experiment Id"},"project_id":{"type":"string","title":"Project Id"},"dataset_id":{"type":"string","format":"uuid","title":"Dataset Id"},"dataset_name":{"type":"string","title":"Dataset Name"},"project_version_id":{"anyOf":[{"type":"string","const":"draft"},{"type":"integer","minimum":0}],"title":"Project Version Id"},"node_contract":{"$ref":"#/components/schemas/EvalNodeContractV2"},"name":{"type":"string","title":"Name"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"created_by":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Created By"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["experiment_id","project_id","dataset_id","dataset_name","project_version_id","node_contract","name","notes","created_by","created_at","updated_at"],"title":"EvalExperiment"},"EvalNodeContractV2":{"properties":{"input_kind":{"type":"string","enum":["start_node","legacy_input_nodes"],"title":"Input Kind"},"input_keys":{"items":{"type":"string"},"type":"array","title":"Input Keys"},"output_node_ids":{"items":{"type":"string"},"type":"array","title":"Output Node Ids"}},"type":"object","required":["input_kind","input_keys","output_node_ids"],"title":"EvalNodeContract"},"StackAIAPIErrorResponse":{"properties":{"response_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Code","description":"Machine-readable response code, when provided."},"meta":{"additionalProperties":true,"type":"object","title":"Meta","description":"Additional metadata","default":{}},"errors":{"items":{"$ref":"#/components/schemas/StackAIAPIError"},"type":"array","title":"Errors","description":"List of errors"},"detail":{"items":{"type":"string"},"type":"array","title":"Detail","description":"Human-readable error messages. Use the HTTP status and error metadata to decide how to handle the failure.","readOnly":true}},"type":"object","required":["detail"],"title":"StackAIAPIErrorResponse","description":"Error response model with status code and error list."},"StackAIAPIError":{"properties":{"message":{"type":"string","title":"Message","description":"Message describing the error"}},"type":"object","required":["message"],"title":"StackAIAPIError","description":"Error detail model."}}},"paths":{"/v2/evals/experiments/{experiment_id}":{"patch":{"tags":["endpoint-updateEvalExperimentV2"],"summary":"Update Eval Experiment","description":"Update metadata; omitted fields remain unchanged and null clears notes.\n\n**How to use**\n\nUpdate metadata only as permitted by the request schema. Omitted fields stay unchanged; null clears notes. This is not a replacement for creating a new experiment snapshot.\n\n**Authentication and permissions**\n\nRequired permissions: `evals.update`. Resource and owner access checks also apply.\n\n**Prepare request.json**\n\nSave the example body below as `request.json` for the curl sample. Replace example IDs, node keys, and dynamic configuration with values for your organization; these are illustrative, not pre-existing resources.\n\n```json\n{\n  \"notes\": \"Reviewed regression run\"\n}\n```","operationId":"updateEvalExperimentV2","parameters":[{"name":"experiment_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Experiment Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalExperimentUpdateRequestV2"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackAIAPIDataResponse_EvalExperimentResponseV2_"}}}},"400":{"description":"Invalid request or pagination cursor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackAIAPIErrorResponse"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackAIAPIErrorResponse"}}}},"403":{"description":"Denied permission, project folder access, or API-key scope (meta.required_scope)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackAIAPIErrorResponse"}}}},"404":{"description":"Resource not found in the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackAIAPIErrorResponse"}}}},"4XX":{"description":"Client error returned in the public API envelope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackAIAPIErrorResponse"}}}}}}}}}
````


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/stackai-api/rest-api-v2/experiments-and-jobs/patch-v2-evals-experiments-experiment_id.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
