# Aliases
API routes for listing, creating, deleting and editing aliases
# Index
# Method
GET
# URL
/api/v1/aliases
# Params
| KEY | DATA TYPE | API KEY TYPE | DEFAULTS/ACCEPTED VALUES | DESCRIPTION |
|---|---|---|---|---|
| api_key | String | Client | required | |
| client_id | Integer | required |
Active only
Response includes only currently active aliases.
# Response
[
{
"id": 1,
"client_id": 1,
"generator": "vqgan",
"alias": "Blockade",
"true_prompt": "blockade",
"public": 1,
"prompts": {
"user_prompts": []
}
},
{
"id": 2,
"client_id": 6,
"generator": "vqgan",
"alias": "Teestt",
"true_prompt": "tesatewt",
"public": 0,
"prompts": {
"user_prompts": [
{
"type": "input", // Type of prompt
"name": "USER_INPUT_1", // slash command parameter name
"api_request_name": "prompt[USER_INPUT_1]", //query parameter name for alias generation API request (POST /api/v1/aliases/{id})
"placeholder": "test", // slash command description
"max-char": "50" // maximum number of characters
},
{
"type": "input", // Type of prompt
"name": "USER_INPUT_2", // slash command parameter name
"api_request_name": "prompt[USER_INPUT_2]", //query parameter name for alias generation API request (POST /api/v1/aliases/{id})
"placeholder": "test 2", // slash command description
"max-char": "33" // maximum number of characters
},
{
"type": "input", // Type of prompt
"name": "USER_INPUT_3", // slash command parameter name
"api_request_name": "prompt[USER_INPUT_3]", //query parameter name for alias generation API request (POST /api/v1/aliases/{id})
"placeholder": "test 3", // slash command description
"max-char": "45" // maximum number of characters
}
]
}
}
]
# Submit
# Method
POST
# URL
/api/v1/aliases/{id}
# Params
| KEY | DATA TYPE | API KEY TYPE | DEFAULTS/ACCEPTED VALUES | DESCRIPTION |
|---|---|---|---|---|
| api_key | String | Client | required | |
prompt[INPUT TYPE_INPUT ID] | array | Input type example: prompt[USER_INPUT_1] = "Some text." File type example: prompt[USER_INPUT_2] = test | required | |
| discord_user_id | Integer | optional | ||
| discord_message_id | Integer | optional | ||
| discord_channel_id | Integer | optional | ||
| discord_guild_id | Integer | optional |
# Response
{
"imaginations": [
{
"id": 61,
"user_id": 5,
"title": "Imagination #61",
"context": null,
"caption_text": null,
"author_name": "client@330.ai",
"prompt": "test 10111 test 2222 test 3",
"alias_id": 2,
"alias_name": "Teestt",
"progress": 0,
"status": "pending",
"queue_position": 1,
"file_url": "http://backend.blockadelabs.com/images/blockade_loader.gif",
"thumb_url": "http://backend.blockadelabs.com/images/blockade_loader.gif",
"video_url": null,
"created_at": "2022-11-17 14:11:34",
"updated_at": "2022-11-17 14:11:34",
"media_version": 0,
"public": 1,
"error_message": null,
"generator": "vqgan",
"generator_data": {
"cuts": 64,
"seed": 0,
"model": "imagenet16k",
"width": 512,
"height": 512,
"prompt": "test 10111 test 2222 black circle",
"cut_power": 1,
"optimizer": "Adam",
"save_zoom": false,
"step_size": 0.1,
"init_image": null,
"init_noise": "none",
"iterations": 200,
"save_video": true,
"zoom_scale": 1.01,
"zoom_start": 200,
"init_weight": 0,
"video_length": 0,
"image_prompts": "",
"negative_text": null,
"zoom_frequency": 10,
"init_image_noise": null,
"prompt_frequency": null
},
"dispatched_at": null,
"processing_at": null,
"processed_at": null,
"completed_at": null
}
]
}