PATCH/api/v1/runs/{runId}
Updates a run’s mutable metadata. Send name, labels, or both; a
request carrying neither is a 400 rather than a silent no-op.
name replaces. labels merge — a null label value removes that
key, and anything not mentioned is left alone. They differ because a
name is a single value while labels are a set: requiring a full resend
to change one label is how the other nineteen get dropped.
This is deliberately not the same as
PATCH /flows/{flowId}/sessions/{sessionId}/config, which replaces.
That endpoint handles credentials, where a half-applied change is
dangerous.
Returns the resulting name and the complete merged label set, so you never have to guess what the run now holds.
Authentication
Requires a project API key — see Authentication.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
runId | path | string | required | UUID of the run. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | optional | Human-readable name, shown in the dashboard. Without one a run is displayed by its trigger — “API Run”, “Chat Session”. |
labels | object | optional |
Responses
| Status | Description |
|---|---|
200 | The run’s resulting metadata. |
400 | Request body or query parameters failed validation. |
404 | Resource not found or not accessible to this project. |
Tag: Runs