Skip to main content
PATCH
Update a character

Authorizations

x-api-key
string
header
required

Your workspace API key, leap_.... Create one at https://app.tryleap.ai/go/api, and keep it on your server.

Path Parameters

id
string
required

The character's ID, chr_....

Body

application/json
name
string

A new name.

Required string length: 1 - 40
images
string[]

New pictures, in place of all the old ones. Leap reads its look again from them.

Required array length: 1 - 4 elements

Response

The character.

A character your workspace keeps. Put its ID in a run's input in place of an image file, and the run gets its pictures and a description of its look, so it comes out the same every time.

id
string
required

The character's ID, chr_.... Pass it wherever a model or recipe takes an image file.

object
string
required
Allowed value: "character"
beta
boolean
required

This endpoint is in beta: its shape can change, or it can go away, without the 180-day notice stable endpoints get.

name
string
required

The character's name.

images
object[]
required

Its pictures, first picture first.

created_at
string<date-time>
required

When it was made.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
updated_at
string<date-time>
required

When its name or pictures last changed.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$