user_sessions

Update User Session

Update a user session (e.g., rename).

Returns 404 if the session is not found or has been deleted.

patch/api/v1/user-sessions/{user_session_id}

Request

  • Base URL: https://docs.omnara.com (the document declares no server; this is the origin it was published from)
  • URL: https://docs.omnara.com/api/v1/user-sessions/{user_session_id}
  • Auth: HTTP bearer

Path parameters

user_session_idstring required

Request body

namestring nullable

New name for the session

Response

Successful Response

kind'user_session'

Descriptor type discriminator

session_idstring uuid required

Unique session identifier

user_idstring uuid required

Owner user identifier

status'ACTIVE' | 'COMPLETED' | 'DELETED' required
created_atstring date-time required

Timestamp when the session was created

namestring nullable

Optional user-defined session name

metadataobject nullable

Arbitrary session metadata

worktree_idstring uuid nullable

Associated worktree identifier

worktree_namestring nullable

Name of the associated worktree

worktree_type'LOCAL' | 'REMOTE'

Whether a worktree runs on a user's local machine or a managed remote machine.

Changes

No recorded changes to this operation across all 1 revision of this API.