Skip to content
Get your keyGet a key

Reference · Library

POST/library/rename

Rename a piece: its @name in prompts, its name, or both

Rename a piece the person keeps — a file they uploaded, a picture, clip or sound made here, a cast member — as Rename on its tile does: its @name, what prompts call it in every studio (e.g. "@vera" to "@vera_couch"), its name where it is kept (an upload’s file name, a picture’s title, a cast member’s name), or both. An @name is letters, numbers and _, and one piece’s in their account whatever its case: one another piece has is refused with a free one to try. From then on the piece is listed by its new @name; call it so in a create tool’s words and referenceNames. The piece is its origin and id: from GET /api/v1/library (either tab) or the piece POST /api/v1/library/use answers; a cast member is origin "cast" with its id from GET /api/v1/cast. Free.

Key needs
create · Make things and spend credits
Spends
Nothing
Answers
Data
Request
curl -X POST https://vessero.com/api/v1/library/rename \
  -H "Authorization: Bearer $VESSERO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "origin": "upload",
    "id": "6c5b4a3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d",
    "atName": "@vera_couch"
  }'

Body

  • originstringrequiredWhere it is kept: upload (a file they brought in), media, clip, card or story (made here, as GET /api/v1/library gives its origin) or cast (a cast member).uploadmediaclipcardstorycast
  • idstringrequiredIts id there: from GET /api/v1/library, POST /api/v1/library/use’s piece or GET /api/v1/cast.
  • atNamestringIts new @name, with or without the @: letters, numbers and _, no spaces, starting with a letter, at most 32, e.g. "@vera_couch".
  • namestringIts new name where it is kept, e.g. "Vera on the couch": an upload’s, a picture’s title or their own cast member’s. A clip, a board card, a story and a starter cast member keep their own.

Answers

  • 200okWhat it did, as data.
  • 400invalid_requestA field is missing or not accepted: see details.
  • 404not_foundNot found on this account.
  • 403feature_unavailableThe studio this needs is switched off for the account right now.
Next in LibraryGET/work