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. Login via Member Login. Use accessToken from response for subsequent requests as the Authorization header with Bearer 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.

Face Swap Resource

Get User Face Swap

Get all stored faces

Authorizations:
SecurityScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Member Resource

Login

Login with email and password

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:
SecurityScheme

Responses

Response samples

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

Delete

Authorizations:
SecurityScheme

Responses

Prompts Resource

Get Prompts

Authorizations:
SecurityScheme
query Parameters
page
required
integer <int32>
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"
query
string

Search query

header Parameters
x-app
string (Site)
Enum: "AIPROFILEPICS" "ECAF" "ALIVEAI"

Responses

Response samples

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

Create Prompt

Create a new prompt for image generation

Authorizations:
SecurityScheme
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+$

Optional seed for image generation. Must be a numeric string.

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 <= 1000 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

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

faceModel
string (FaceModel)
Enum: "REALISM" "CREATIVE"
faceImproveStrength
integer <int32> [ 0 .. 10 ]
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"
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 ]

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

Authorizations:
SecurityScheme
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 Edit Breasts

Authorizations:
SecurityScheme
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:
SecurityScheme
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:
SecurityScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
mediaId
required
string
createdFromPromptId
required
string
ignoreFace
required
boolean
restoreFace
required
boolean
prompt
string <= 200 characters
object (PoseRequest)
object (ClothesRequest)
Array of objects (QwenTemplateRequest) [ 1 .. 5 ] items

Responses

Request samples

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

Response samples

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

Upscale Image

Authorizations:
SecurityScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
mediaId
required
string
createdFromPromptId
required
string
restoreFace
required
boolean
upscaleModel
string (UpscaleModel)
Enum: "DEFAULT" "ALTERNATIVE" "SKIN_DETAIL"

Responses

Request samples

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

Response samples

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

Edit Video Extend

Authorizations:
SecurityScheme
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:
SecurityScheme
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 Face Improve Prompt

Authorizations:
SecurityScheme
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:
SecurityScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
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 .. 300 ] characters

Text prompt describing the content of the video to be generated

scene
string [ 1 .. 300 ] 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"

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:
SecurityScheme
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:
SecurityScheme
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 <= 200 characters

Responses

Request samples

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

Response samples

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

Get Pending

Get pending prompts in the user's queue

Authorizations:
SecurityScheme

Responses

Response samples

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

Create Portrait

Authorizations:
SecurityScheme
query Parameters
serverId
string
Request Body schema: application/json
required
seed
string
required
object (FaceSwapRequest)
model
string (Model)
Enum: "DEFAULT" "REALISM" "ANIME" "TEMPORARY"
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:
SecurityScheme
query Parameters
promptId
required
string

Responses

Socket Dto

Unused endpoint to show the Websocket payload for a prompt event

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-10 16:15:50+00:00"
}

Socket Dto 2

Unused endpoint to show the Websocket payload for a user event

Responses

Response samples

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

Upscale Video

Authorizations:
SecurityScheme
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 Video Prompt

Authorizations:
SecurityScheme
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": {
    }
}

Get Prompt

Authorizations:
SecurityScheme
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": {
    },
  • "isFavorite": true,
  • "medias": [
    ]
}

Delete Prompt

Deletes a completed prompt

Authorizations:
SecurityScheme
path Parameters
promptId
required
string

Responses

Template Resource

Get Templates

Get all public and user Image LoRAs.

Authorizations:
SecurityScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Edit Templates

Get all public and user Image Edit LoRAs.

Authorizations:
SecurityScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upload Resource

Upload File

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

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

Responses

Response samples

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

Get User Uploads

Authorizations:
SecurityScheme
query Parameters
mediaIds
Array of strings

Responses

Response samples

Content type
application/json
[
  • "string"
]

Video Template Resource

Get Templates

Get all public and user Video LoRAs.

Authorizations:
SecurityScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]