Renames the run; an empty name clears it.

PUT

/v1/m/sessions/runs/{ref}/name

curl --request PUT \
  --url https://example.com/v1/m/sessions/runs/example/name \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

• this engine

Renames the run; an empty name clears it. The route supplies run-write authorization in the run’s recorded workspace.

Authorizations

• bearerAuth
• browserSession

Parameters

Path Parameters

ref

required

string

Path parameter ref.

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body ^required

Media type application/json

object

name

required

The session’s new name, trimmed; at most 200 characters, no control or invisible (format, line or paragraph separator) characters. An empty name clears it.

string

<= 200 characters

Example ^generated

{
  "name": "example"
}

Responses

200

The run resource after the change

Media type application/json

object

run_ref

required

The operated session’s stable reference.

string

state

required

The run’s derived lifecycle state after the control.

string

key

additional properties

any

Example ^generated

{
  "run_ref": "example",
  "state": "example"
}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}