API reference · Account
Name a link, or list it in the public feed
PATCH/api/studio/shares/{id}Signed in session
title names the link on its page and its card (null takes it away); listed puts it in the public feed or takes it out, a 409 feed_off while the operator has the feed off. The operator's hide stands either way. The signed in account; same origin for a write.
Parameters
| Field | Type | What it is |
|---|---|---|
| id (path)required | string | The link's id: 22 characters of base64url. |
Request body
application/json, required
| Field | Type | What it is |
|---|---|---|
| title | string or null | At most 100 characters. |
| listed | boolean |
Example
{
"title": "string",
"listed": false
}Answer 200
The link as it stands.
| Field | Type | What it is |
|---|---|---|
| idrequired | string | |
| objectrequired | string | One of "studio.share". |
| asset_idrequired | string | |
| job_idrequired | string or null | The job that made the take, when a job did. |
| doc_asset_idrequired | string or null | The editor's own asset id the file was uploaded under, when one was named. |
| promptrequired | string or null | |
| modelrequired | string or null | |
| titlerequired | string or null | The title the sharer gave the link, on its page and its card. |
| settingsrequired | object or null | The take's settings, which a remix from the public feed starts from. |
| settings. | string | |
| settings. | string | |
| settings. | string | |
| settings. | number | |
| settings. | string | |
| posterrequired | boolean | A poster frame is kept for the link card. |
| listed_atrequired | integer or null | Listed in the public feed since (unix seconds), by the sharer's choice. |
| hiddenrequired | boolean | The operator hid the listing from the feed. |
| viewsrequired | integer | Visitors who watched it from the feed or its page, each once a UTC day. |
| urlrequired | string | The page's path on this origin, /studio/share/{id}. |
| created_atrequired | integer | |
| revoked_atrequired | integer or null |
Errors
- 400OpenAI shaped error.
- 401OpenAI shaped error.
- 403OpenAI shaped error.
- 404OpenAI shaped error.
- 409OpenAI shaped error.
- 429OpenAI shaped error.
Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.