API docs by Redocly

AliveAI API (1.0.0)

Download OpenAPI specification:

AliveAI: hello@AliveAi.app URL: https://aliveai.app

API documentation for AliveAI services. For custom integration or business inquiries, please contact us.

How it works

  1. Choose your login type
    1. Login via Member Login. Use accessToken from response for subsequent requests as the Authorization header with Bearer prefix.
    2. Login via API-Key. Create an API-Key in the Dashboard and use it as the Authorization header with Key prefix.
  2. Start an AI generation. Core endpoints are Create Image Generation and Create Video Generation. From the response, get the promptId.
  3. Connect to the websocket endpoint at wss://api.aliveai.app/ws/prompts/{promptId} to receive real-time updates on the generation process.

Prompts Manager Resource

Endpoints for managing completed prompts.

Get Prompts

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
page
required
integer <int32> >= 0
pageSize
integer <int32> <= 20
promptType
Array of strings (PromptType)
Items Enum: "IMAGE_DEFAULT" "VIDEO_EXPRESSION" "FACE_IMPROVE" "AFTER_FACE_SWAP" "EDIT_BREASTS" "PORTRAIT" "IMAGE_TO_VIDEO" "EXTEND_VIDEO" "UPSCALE_VIDEO" "INPAINT" "IMPROVE_EYES" "GOOGLE_INPAINT" "EDIT_IMAGE" "EDIT_VIDEO_INCREASE_FPS" "EDIT_UPSCALE_IMAGE" "CHARACTER_IMAGE" "EDIT_IMPROVE_FACE" "CREATE_FACE" "EDIT_ENHANCE" "EDIT_VAGINA" "CHARACTER_TRAINING_DATA"
query
string

Search query

Responses

Response samples

Content type
application/json
{
  • "prompts": [
    ],
  • "hasNextPage": true,
  • "totalPageCount": 0
}

Delete Prompt

Deletes a completed prompt

Authorizations:
SecuritySchemeApiKeyScheme
path Parameters
promptId
required
string

Responses

Get Prompt

Authorizations:
SecuritySchemeApiKeyScheme
path Parameters
promptId
required
string

Responses

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "originalPrompt": {
    },
  • "originalVideoExpressionPrompt": {
    },
  • "faceImprovePrompt": {
    },
  • "afterFaceSwapPrompt": {
    },
  • "editBreastsRequest": {
    },
  • "createPortraitRequest": {
    },
  • "imageToVideoRequest": {
    },
  • "inpaintRequest": {
    },
  • "eyeImproveRequest": {
    },
  • "googleInpaintRequest": {
    },
  • "editVideoIncreaseFpsRequest": {
    },
  • "createExtendVideoRequest": {
    },
  • "createEditImageRequest": {
    },
  • "createUpscaleImageRequest": {
    },
  • "createUpscaleVideoRequest": {
    },
  • "createCharacterImageRequest": {
    },
  • "createEditImproveFaceRequest": {
    },
  • "createFaceRequest": {
    },
  • "createEnhanceImageRequest": {
    },
  • "createEditVaginaRequest": {
    },
  • "createCharacterTrainingDataRequest": {
    },
  • "isFavorite": true,
  • "medias": [
    ]
}

Prompts Resource

Endpoints for creating and managing prompt queue for image and video generation.

Create Prompt

Create a new prompt for image generation

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string

Optional server ID to use for prompt processing. If empty it will select an available server.

header Parameters
CF-Connecting-IP
string
Request Body schema: application/json
required
seed
string^\d{1,18}$

Optional seed for image generation. Must be a numeric string (max 18 digits).

name
required
string <= 200 characters

Name of the character. Affects the characters face. A unique and realistic First and Last name is recommended.

appearance
required
string <= 1500 characters

Describe the appearance of the character.

gender
string (Gender)
Enum: "MALE" "FEMALE" "TRANS"
background
string <= 1000 characters
fromLocation
string <= 100 characters
faceDetails
string <= 1000 characters

Details only affecting the face

faceImproveEnabled
boolean
Default: true

If enabled it will improve the face using the faceDetails prompt.

faceModel
string (FaceModel)
Default: "REALISM"
Enum: "REALISM" "CREATIVE"

Specify the model used for the face improve step. Only applies if faceImproveEnabled is true.

faceImproveStrength
integer <int32> [ 0 .. 10 ]
Default: 5

Strength of the face details improvement. Higher values will make the face details more dominant but can also lead to less coherent images. Only applies if faceImproveEnabled is true. Recommended default value is 5.

negativeDetails
string <= 1000 characters

Negative details to avoid in the image generation.

scene
string <= 1000 characters

Additional scene details to enhance the image generation.

object (PoseRequest)
object (FaceSwapRequest)

Optional Face swap configuration

model
string (Model)
Enum: "DEFAULT" "REALISM" "ANIME" "TEMPORARY" "CHARACTER_CREATOR"
modelTemplate
string (ModelTemplate)
Deprecated
Enum: "BUKKAKE" "FEET" "SELFIE" "LESBIAN" "SOCIALMEDIA"
Array of objects (TemplateRequest) [ 1 .. 10 ] items
blockExplicitContent
boolean

If enabled AI will avoid nudity. Works best with DEFAULT AI model

detailLevel
required
string (DetailLevel)
Enum: "MEDIUM" "HIGH"
aspectRatio
string (AspectRatio)
Enum: "DEFAULT" "SQUARE" "PORTRAIT" "LANDSCAPE"
cfg
integer <int32> [ 1 .. 10 ]
Default: 5

Classifier-Free Guidance scale. Higher values will make the image generation more closely follow the prompt, but can also lead to less coherent images. Recommended default value is 5.

object (ClothesRequest)

Optional clothes configuration. Only applies to the CHARACTER_CREATOR model and will be ignored for other models.

Responses

Request samples

Content type
application/json
{
  • "name": "Marcielle Strongmaid",
  • "appearance": "a strong viking woman, blonde hair, hazel eyes, powerful face, wearing revealing viking armour, full body",
  • "gender": "FEMALE",
  • "fromLocation": "NORWAY",
  • "faceImproveEnabled": true,
  • "model": "DEFAULT"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Create After Face Swap

Changes the face of an existing image

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
mediaId
required
string
required
object (FaceSwapRequest)
createdFromPromptId
string

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "mediaId": "string",
  • "faceSwap": {
    },
  • "createdFromPromptId": "string"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Create Character Image

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string^\d{1,18}$

Optional seed for image generation. Must be a numeric string (max 18 digits).

prompt
required
string <= 1000 characters
profileId
required
string
aspectRatio
required
string (AspectRatio)
Enum: "DEFAULT" "SQUARE" "PORTRAIT" "LANDSCAPE"
highResolution
required
boolean
characterType
required
string (CharacterType)
Enum: "ZIMAGE" "FLUX"
Array of objects (QwenTemplateRequest) [ 1 .. 5 ] items
characterStrength
number <double> [ 0 .. 2 ]
object (PoseRequest)
object (ClothesRequest)
improveFace
required
boolean
improveBreasts
required
boolean
improveVagina
required
boolean

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "prompt": "string",
  • "profileId": "string",
  • "aspectRatio": "DEFAULT",
  • "highResolution": true,
  • "characterType": "ZIMAGE",
  • "modelTemplates": [
    ],
  • "characterStrength": 2,
  • "pose": {
    },
  • "clothesRequest": {
    },
  • "improveFace": true,
  • "improveBreasts": true,
  • "improveVagina": true
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Create Character Training Data

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
mediaId
required
string
createdFromPromptId
required
string
prompt
required
string <= 300 characters

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "mediaId": "string",
  • "createdFromPromptId": "string",
  • "prompt": "string"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Create Face

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string^\d{1,18}$

Optional seed for image generation. Must be a numeric string (max 18 digits).

faceCreationModel
required
string (FaceCreationModel)
Default: "DEFAULT"
Enum: "DEFAULT" "NANOBANANA"
prompt
required
string <= 500 characters
extraRandomness
required
boolean

Add more randomness to the face generation. This can lead to more unique and varied results, but may also result in less consistent faces across generations with the same prompt. Only for model DEFAULT

createdFromPromptId
string

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "faceCreationModel": "DEFAULT",
  • "prompt": "string",
  • "extraRandomness": true,
  • "createdFromPromptId": "string"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Create Edit Breasts

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
mediaId
required
string
createdFromPromptId
string

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "mediaId": "string",
  • "createdFromPromptId": "string"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Edit Eyes

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
mediaId
required
string
createdFromPromptId
required
string
text
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "mediaId": "string",
  • "createdFromPromptId": "string",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Edit Image

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
editModel
required
string (EditModel)
Enum: "CREATIVE" "REALISM"
seed
string
mediaId
required
string
createdFromPromptId
required
string
ignoreFace
required
boolean
restoreFace
required
boolean
prompt
string <= 400 characters
object (PoseRequest)
object (ClothesRequest)
Array of objects (QwenTemplateRequest) [ 1 .. 5 ] items
maskMediaId
string

Responses

Request samples

Content type
application/json
{
  • "editModel": "CREATIVE",
  • "seed": "string",
  • "mediaId": "string",
  • "createdFromPromptId": "string",
  • "ignoreFace": true,
  • "restoreFace": true,
  • "prompt": "string",
  • "pose": {
    },
  • "clothesRequest": {
    },
  • "modelTemplates": [
    ],
  • "maskMediaId": "string"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Create Edit Improve Face

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
mediaId
required
string
faceDetails
string
createdFromPromptId
required
string

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "mediaId": "string",
  • "faceDetails": "string",
  • "createdFromPromptId": "string"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Upscale Image

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
mediaId
required
string
createdFromPromptId
required
string
restoreFace
required
boolean
prompt
string <= 2000 characters
strength
number <double>
upscaleModel
string (UpscaleModel)
Enum: "DEFAULT" "ALTERNATIVE" "SKIN_DETAIL" "SEEDVR"

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "mediaId": "string",
  • "createdFromPromptId": "string",
  • "restoreFace": true,
  • "prompt": "string",
  • "strength": 0.1,
  • "upscaleModel": "DEFAULT"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Edit Vagina

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
mediaId
required
string
createdFromPromptId
required
string
prompt
string <= 300 characters

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "mediaId": "string",
  • "createdFromPromptId": "string",
  • "prompt": "string"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Edit Video Extend

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
mediaId
required
string
prompt
required
string [ 1 .. 500 ] characters
createdFromPromptId
string
Array of objects (TemplateRequest) [ 1 .. 5 ] items

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "mediaId": "string",
  • "prompt": "string",
  • "createdFromPromptId": "string",
  • "videoTemplates": [
    ]
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Edit Video Increase Fps

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
mediaId
required
string
createdFromPromptId
string

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "mediaId": "string",
  • "createdFromPromptId": "string"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Create Enhance Image

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
mediaId
required
string
createdFromPromptId
string
prompt
string <= 500 characters

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "mediaId": "string",
  • "createdFromPromptId": "string",
  • "prompt": "string"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Create Face Improve Prompt

Improves the face of an existing image

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
mediaId
required
string
faceDetails
string
negativeFaceDetails
string
strength
required
integer <int32> [ 1 .. 100 ]
faceIndex
integer <int32>
createdFromPromptId
string
faceModel
string (FaceModel)
Enum: "REALISM" "CREATIVE"

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "mediaId": "string",
  • "faceDetails": "string",
  • "negativeFaceDetails": "string",
  • "strength": 1,
  • "faceIndex": 0,
  • "createdFromPromptId": "string",
  • "faceModel": "REALISM"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Create Image To Video

Create a new prompt for video generation

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string^\d{1,18}$

Optional seed for image generation. Must be a numeric string (max 18 digits).

videoModel
required
string (VideoModel)
Enum: "DEFAULT" "AUDIO" "GROK"
mediaId
required
string

ID of the media (image) to be used as the source for video generation

lastFrameMediaId
string

ID of the media (image) to be used as the last frame in the video

customImage
boolean

Indicates whether a custom image (external image upload) is used for video generation

text
required
string [ 1 .. 1500 ] characters

Text prompt describing the content of the video to be generated

scene
string [ 1 .. 600 ] characters

Scene description to provide additional context for video generation

template
string (ImageToVideoTemplate)
Deprecated
Enum: "TITTY_DROP" "SPIN_360" "MISSIONARY" "BOOB_BOUNCE" "BLOWJOB"
createdFromPromptId
string
Array of objects (TemplateRequest) [ 1 .. 5 ] items
videoLength
string (VideoLength)
Default: "SHORT"
Enum: "SHORT" "MEDIUM"

Length of the generated video. SHORT = 5 seconds. MEDIUM = 10 seconds. SHORT is recommended

videoFrameRate
string (VideoFrameRate)
Enum: "LOW" "MEDIUM" "HIGH"
videoQuality
string (VideoQuality)
Enum: "V_480P" "V_720P"

Quality of the generated video. Only applicable to videoModel GROK

motionStrength
integer <int32> [ 0 .. 6 ]

Optional. Adds additional motion to the video. Use it to avoid slow motion look. Only applicable to videoModel DEFAULT.

Responses

Request samples

Content type
application/json
{
  • "mediaId": "1234",
  • "text": "She is walking towards the camera and then turns around to show her back, revealing her full body in a sexy pose"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Inpaint

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
maskMediaId
required
string
originalMediaId
required
string
createdFromPromptId
required
string
strength
required
integer <int32> [ 1 .. 100 ]
prompt
required
string <= 200 characters
negativePrompt
string <= 200 characters

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "maskMediaId": "string",
  • "originalMediaId": "string",
  • "createdFromPromptId": "string",
  • "strength": 1,
  • "prompt": "string",
  • "negativePrompt": "string"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Inpaint Google

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
mediaId
required
string
object (CropArea)
base64Png
string
createdFromPromptId
required
string
prompt
required
string <= 400 characters
googleModel
required
string (GoogleModel)
Enum: "GEMINI_2_5" "GEMINI_3_PRO"

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "mediaId": "string",
  • "cropArea": {
    },
  • "base64Png": "string",
  • "createdFromPromptId": "string",
  • "prompt": "string",
  • "googleModel": "GEMINI_2_5"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Get Pending

Get pending prompts in the user's queue

Authorizations:
SecuritySchemeApiKeyScheme

Responses

Response samples

Content type
application/json
{
  • "queue": [
    ]
}

Create Portrait

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
required
object (FaceSwapRequest)
model
string (Model)
Enum: "DEFAULT" "REALISM" "ANIME" "TEMPORARY" "CHARACTER_CREATOR"
detailLevel
required
string (DetailLevel)
Enum: "MEDIUM" "HIGH"
gender
required
string (PortraitGender)
Enum: "MALE" "FEMALE"
ethnicity
required
string (Ethnicity)
Enum: "AFRICAN" "ASIAN" "EUROPEAN" "INDIAN" "MIDDLE_EASTERN" "NATIVE_AMERICAN" "PACIFIC_ISLANDER" "MULTIRACIAL" "LATINO"
scene
required
string (Scene)
Enum: "HEADSHOT" "PHOTOSTUDIO" "FULL_BODY" "BEACH" "ADVENTURE" "FORMAL"
aspectRatio
string (AspectRatio)
Enum: "DEFAULT" "SQUARE" "PORTRAIT" "LANDSCAPE"
createdFromPromptId
string

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "faceSwap": {
    },
  • "model": "DEFAULT",
  • "detailLevel": "MEDIUM",
  • "gender": "MALE",
  • "ethnicity": "AFRICAN",
  • "scene": "HEADSHOT",
  • "aspectRatio": "DEFAULT",
  • "createdFromPromptId": "string"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Delete From Queue

Delete a prompt from the user's queue

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
promptId
required
string

Responses

Upscale Video

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
videoUpscaleModel
required
string (VideoUpscaleModel)
Enum: "DEFAULT" "HIGH_DETAIL"
mediaId
required
string
createdFromPromptId
string

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "videoUpscaleModel": "DEFAULT",
  • "mediaId": "string",
  • "createdFromPromptId": "string"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Create Video Prompt

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
mediaId
required
string
videoExpression
required
string (VideoExpression)
Enum: "SMILE_BIG" "SMILE_SMALL" "MOAN_EYES_OPEN" "MOAN_EYES_CLOSED" "KISS" "SHOCKED"
createdFromPromptId
string

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "mediaId": "string",
  • "videoExpression": "SMILE_BIG",
  • "createdFromPromptId": "string"
}

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "seed": "string",
  • "promptContainer": {
    }
}

Websocket Prompt Event Example

Unused endpoint to show the Websocket payload for a prompt event. Connect to wss://api.aliveai.app/ws/prompts/{promptId} to receive real-time updates for the prompt.

Authorizations:
ApiKeyScheme

Responses

Response samples

Content type
application/json
{
  • "promptId": "string",
  • "progress": 0,
  • "isComplete": true,
  • "promptContainer": {
    },
  • "isError": true,
  • "isSystem": true,
  • "message": "string",
  • "errorType": "UNKNOWN",
  • "queuePosition": 0,
  • "created": "2022-03-10T16:15:50Z"
}

Websocket User Event Example

Unused endpoint to show the Websocket payload for a user event. Connect to wss://api.aliveai.app/ws/users/r9orK?token={bearerToken} to receive real-time updates for the user queue.

Authorizations:
ApiKeyScheme

Responses

Response samples

Content type
application/json
{
  • "eventType": "QUEUE_CHANGE",
  • "queue": [
    ],
  • "promptId": "string"
}

Upload Resource

Upload File

Upload a file to the server. Returns a mediaId which can be used to reference the file later.

Authorizations:
SecuritySchemeApiKeyScheme
Request Body schema: multipart/form-data
required
name
string
image
string <binary>

Responses

Response samples

Content type
application/json
{
  • "mediaId": "string",
  • "mediaType": "IMAGE"
}

Clothes Resource

Get Public Clothes

Get all public clothes

Authorizations:
SecuritySchemeApiKeyScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Custom Clothes

Get custom clothes

Authorizations:
SecuritySchemeApiKeyScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Custom Clothes

Delete custom clothes

Authorizations:
SecuritySchemeApiKeyScheme
path Parameters
clothesId
required
string

Responses

Get Custom Clothes

Get custom clothes by ID

Authorizations:
SecuritySchemeApiKeyScheme
path Parameters
clothesId
required
string

Responses

Response samples

Content type
application/json
{
  • "clothesId": "string",
  • "clothesPrompt": "string",
  • "clothesImageUrl": "string"
}

Llm Resource

Generate Character Builder Prompt

Creates an extended text prompt for the character builder

Authorizations:
SecuritySchemeApiKeyScheme
Request Body schema: application/json
required
model
required
string (LlmModel)
Enum: "QWEN3_235B" "QWEN3_8B" "GROK" "MISTRAL" "RAW"
hairStyle
string [ 2 .. 250 ] characters
hairColor
string [ 2 .. 250 ] characters
age
string [ 2 .. 250 ] characters
body
string [ 2 .. 250 ] characters
outfit
string [ 2 .. 250 ] characters
ethnicity
string [ 2 .. 250 ] characters
theme
string [ 2 .. 250 ] characters
style
string [ 2 .. 250 ] characters
pose
string [ 2 .. 250 ] characters

Responses

Request samples

Content type
application/json
{
  • "model": "QWEN3_235B",
  • "hairStyle": "string",
  • "hairColor": "string",
  • "age": "string",
  • "body": "string",
  • "outfit": "string",
  • "ethnicity": "string",
  • "theme": "string",
  • "style": "string",
  • "pose": "string"
}

Response samples

Content type
application/json
{
  • "promptText": "string"
}

Generate Character Prompt

Creates an extended text prompt for a character (for a trainer or imported profile)

Authorizations:
SecuritySchemeApiKeyScheme
Request Body schema: application/json
required
profileId
required
string
theme
required
string
outfit
required
string
additionalDetails
string

Responses

Request samples

Content type
application/json
{
  • "profileId": "string",
  • "theme": "string",
  • "outfit": "string",
  • "additionalDetails": "string"
}

Response samples

Content type
application/json
{
  • "promptText": "string"
}

Get Clothes Description

Creates an extended text prompt describing clothes based on the provided clothes ID

Authorizations:
SecuritySchemeApiKeyScheme
path Parameters
clothesId
required
string

Responses

Response samples

Content type
application/json
{
  • "promptText": "string"
}

Generate Prompt

Creates an extended text prompt based on the provided input

Authorizations:
SecuritySchemeApiKeyScheme
Request Body schema: application/json
required
model
required
string (Model)
Enum: "DEFAULT" "REALISM" "ANIME" "TEMPORARY" "CHARACTER_CREATOR"
inputPrompt
required
string [ 5 .. 250 ] characters \S

Responses

Request samples

Content type
application/json
{
  • "model": "DEFAULT",
  • "inputPrompt": "string"
}

Response samples

Content type
application/json
{
  • "promptText": "string"
}

Generate Update Prompt

Updates an existing prompt from the character builder with new information

Authorizations:
SecuritySchemeApiKeyScheme
Request Body schema: application/json
required
model
required
string (LlmModel)
Enum: "QWEN3_235B" "QWEN3_8B" "GROK" "MISTRAL" "RAW"
oldRequest
required
string
required
object (LlmBuilderPromptRequest)

Responses

Request samples

Content type
application/json
{
  • "model": "QWEN3_235B",
  • "oldRequest": "string",
  • "newRequest": {
    }
}

Response samples

Content type
application/json
{
  • "promptText": "string"
}

Generate Video Prompt

Creates an extended text prompt to be used as a video script

Authorizations:
SecuritySchemeApiKeyScheme
Request Body schema: application/json
required
model
required
string (VideoLlmModel)
Enum: "DEFAULT" "UNCENSORED"
userInput
required
string [ 5 .. 500 ] characters
sceneContext
string

Optional scene description from a vision description

frameCount
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "model": "DEFAULT",
  • "userInput": "string",
  • "sceneContext": "string",
  • "frameCount": 0
}

Response samples

Content type
application/json
{
  • "promptText": "string",
  • "negPrompt": "string"
}

Generate Vision Prompt

Creates an extended text prompt describing an existing image

Authorizations:
SecuritySchemeApiKeyScheme
Request Body schema: application/json
required
mediaId
required
string

Responses

Request samples

Content type
application/json
{
  • "mediaId": "string"
}

Response samples

Content type
application/json
{
  • "promptText": "string"
}

Member Resource

Login

Login with email and password

Authorizations:
ApiKeyScheme
header Parameters
CF-Connecting-IP
string
Request Body schema: application/json
required
email
required
string\S
password
required
string\S

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string"
}

Me

Get current user information

Authorizations:
SecuritySchemeApiKeyScheme

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "credits": 0,
  • "email": "string",
  • "apiKey": "string",
  • "emailConfirmed": true,
  • "hasPurchase": true,
  • "premiumExpiration": "2022-03-10T12:15:50-04:00",
  • "created": "2022-03-10T12:15:50-04:00"
}

Poses Resource

Get Poses

Authorizations:
SecuritySchemeApiKeyScheme

Responses

Response samples

Content type
application/json
{
  • "posesStanding": {
    },
  • "posesLying": {
    },
  • "posesAllFours": {
    },
  • "posesKneeling": {
    },
  • "posesSitting": {
    },
  • "posesSquatting": {
    },
  • "posesSuspended": {
    },
  • "posesPorn": {
    }
}

Get Custom Poses

Authorizations:
SecuritySchemeApiKeyScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Custom Pose

Authorizations:
SecuritySchemeApiKeyScheme
path Parameters
poseId
required
string

Responses

Get Custom Pose

Authorizations:
SecuritySchemeApiKeyScheme
path Parameters
poseId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "image": "string",
  • "additionalPrompt": "string"
}

Profile Resource

Get Profiles For User

Get Profiles

Authorizations:
SecuritySchemeApiKeyScheme
query Parameters
page
required
integer <int32> >= 0
public
boolean

true view all profiles, false view only your profiles

sort
string (ProfileSortType)
Enum: "NEW" "TOP"

Responses

Response samples

Content type
application/json
{
  • "profiles": [
    ],
  • "hasNextPage": true
}

Template Resource

Get Templates

Get all public and user Image LoRAs.

Authorizations:
SecuritySchemeApiKeyScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Edit Templates

Get all public and user Image Edit LoRAs for Creative.

Authorizations:
SecuritySchemeApiKeyScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Edit Templates Realism

Get all public and user Image Edit LoRAs for Realism.

Authorizations:
SecuritySchemeApiKeyScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Video Template Resource

Get Templates

Get all public and user Video LoRAs.

Authorizations:
SecuritySchemeApiKeyScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Ltx Video Templates

Get all public and user Video LoRAs.

Authorizations:
SecuritySchemeApiKeyScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]