Skip to main content
PATCH
Rename Output

Authorizations

Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Headers

X-UI-Organization-ID
string | null

Platform admins only: choose an organization for scoped reads and writes. Required to change another organization's study or use its wallet.

Maximum string length: 128

Path Parameters

session_id
string<uuid>
required
output_id
string<uuid>
required

Body

application/json
name
string
required
Required string length: 1 - 200

Response

Successful Response

id
string<uuid>
required
session_id
string<uuid>
required
type
string
required
name
string
required
status
string
required
content
string | null
prompt
string | null
is_default
boolean
default:false
references
HubReference · object[]
download_url
string | null
created_at
string<date-time> | null
updated_at
string<date-time> | null