Promptchan API

https://promptchan.com/docs
Admin
Promptchan API is an AI-powered image generation platform with video and chat capabilities, offering...
Tokens:3,311
Snippets:17
Trust Score:9.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET /api/external/video_v4/status_with_logs/{request_id}

Source: https://promptchan.com/docs

Returns queue and progress information for a previously submitted video generation request.

```APIDOC
## GET /api/external/video_v4/status_with_logs/{request_id}

### Description
Returns queue and progress information for a previously submitted video generation request.

### Method
GET

### Endpoint
https://prod.aicloudnetservices.com/api/external/video_v4/status_with_logs/{request_id}

### Parameters
#### Path Parameters
- **request_id** (string) - Required - The request ID returned by the submit endpoint.

### Response
#### Success Response (200)
- **current_queue_length** (integer) - Current queue length.
- **initial_queue_length** (integer) - Initial queue length.
- **progress** (integer) - Progress percentage.

#### Response Example
{
  "current_queue_length": 0,
  "initial_queue_length": 0,
  "progress": 0
}
```

--------------------------------

### Get video generation status

Source: https://promptchan.com/docs

Response format for checking the current queue and progress of a job.

```json
{
  "current_queue_length": 0,
  "initial_queue_length": 0,
  "progress": 0
}
```

--------------------------------

### GET /api/external/video_v4/result/{request_id}

Source: https://promptchan.com/docs

Returns the generated video URL array and related metadata once processing is complete.

```APIDOC
## GET /api/external/video_v4/result/{request_id}

### Description
Returns the generated video URL array and related metadata once processing is complete.

### Method
GET

### Endpoint
https://prod.aicloudnetservices.com/api/external/video_v4/result/{request_id}

### Parameters
#### Path Parameters
- **request_id** (string) - Required - The request ID returned by the submit endpoint.

### Response
#### Success Response (200)
- **gems** (number) - Remaining gems balance.
- **message** (string) - Status message.
- **status** (string) - Operation status.
- **video** (array) - List of generated video URLs.

#### Response Example
{
  "gems": 999860.45,
  "message": "Data received and processed",
  "status": "success",
  "video": ["https://storage.googleapis.com/temp-ie34w60fz7mc6nge/temp/videos/2MsCsX6EyTOmTFzHRBe9.mp4"]
}
```

--------------------------------

### POST /api/external/create

Source: https://promptchan.com/docs

Generates an image based on provided parameters with a base cost of 1 Gem per image.

```APIDOC
## POST /api/external/create

### Description
Generates an image based on provided parameters. Requires ApiKeyAuth for authorization.

### Method
POST

### Endpoint
https://prod.aicloudnetservices.com/api/external/create

### Parameters
#### Request Body
- **style** (string) - Optional - Art style of the image. Enum: "Cinematic", "Anime", "Hyperreal", "Hyperanime", "K-Pop", "Fur", "Furtoon", "Render XL+", "Illustration XL+", "Anime XL", "Anime XL+", "Hardcore XL", "Cinematic XL", "Photo XL+", "Hyperreal XL+", "Hyperreal XL+ v2", "Photo XL+ v2". Defaults to 'Cinematic'.
- **poses** (object) - Optional - Pose for the generated image.
- **filter** (string) - Optional - Filter applied to the image. Enum: "Default", "Cinematic", "Studio", "Flash", "Analog", "Professional", "Polaroid", "Vintage", "Manga", "Cyberpunk", "VHS", "Pixel XL", "Comic XL", "Retro Porn XL", "Fire Style XL", "Hyper", "3D", "Sketch", "Watercolor", "Lineart", "Moody", "Oil Painting", "Rainbow", "Artsy", "Artsy 2", "Cartoon", "Cartoon Vintage", "Painted", "Cartoon 2", "Cartoon 3", "Cartoon Minimalist", "Character Sheet", "Vintage Comic", "Pixel Art", "Anime Studio", "Polariod Picture", "Flash Photo", "Noir Movie", "Analog Photo", "Vintage Photo". Defaults to 'Default'.
- **emotion** (string) - Optional - Adjust for dynamic character expressions. Enum: "Default", "Upset", "Disgusted", "Scared", "Winking", "Angry", "Smiling", "Laughing", "Ouch", "Shocked", "Orgasm Face", "Stick out Tongue".
- **detail** (float) - Optional - Detail level of the image stylization, recommended between -2 and 2.
- **prompt** (string) - Optional - Text prompt for guiding the image generation.
- **seed** (integer) - Optional - Seed for deterministic results. Use -1 for random.
- **quality** (string) - Optional - Quality setting. Enum: "Ultra", "Extreme", "Max". Defaults to 'Ultra'.
- **creativity** (integer) - Optional - Creativity level, recommended values are 30, 50, 70.
- **image_size** (string) - Optional - Size of the generated image. Enum: "512x512", "512x768", "768x512".
- **negative_prompt** (string) - Optional - Text prompt specifying what to avoid.
- **restore_faces** (boolean) - Optional - Whether to apply face restoration.
- **age_slider** (integer) - Optional - Slider to control perceived age (min 18).
- **weight_slider** (float) - Optional - Slider to control body weight, recommended between -1 and 1.
- **breast_slider** (float) - Optional - Slider to adjust breast size, recommended between -1 and 1.
- **ass_slider** (float) - Optional - Slider to adjust ass size, recommended between -1 and 1.

### Request Example
{
  "style": "Cinematic",
  "poses": "Default",
  "filter": "Default",
  "emotion": "Default",
  "detail": null,
  "prompt": "string",
  "seed": 0,
  "quality": "Ultra",
  "creativity": 0,
  "image_size": "512x512",
  "negative_prompt": "string",
  "restore_faces": true,
  "age_slider": 0,
  "weight_slider": null,
  "breast_slider": null,
  "ass_slider": null
}

### Response
#### Success Response (200)
- **image** (string) - The generated image data.
- **gems** (integer) - Remaining gems balance.

#### Response Example
{
  "image": "string",
  "gems": 0
}
```

--------------------------------

### Submit a video generation request

Source: https://promptchan.com/docs

Payload structure for initiating a new video generation job.

```json
{
  "aspect": "Portrait",
  "audioEnabled": false,
  "prompt": "a cinematic portrait of a blonde woman looking at the camera, soft studio lighting",
  "style": "Photo XL+ v2",
  "weight_slider": 0.3,
  "breast_slider": -0.2,
  "ass_slider": 0.1,
  "age_slider": 24,
  "seed": 420,
  "pose": "Default"
}
```

--------------------------------

### POST /api/external/video_v4/submit

Source: https://promptchan.com/docs

Creates a video generation job and returns a request ID for polling status and retrieving the final result.

```APIDOC
## POST /api/external/video_v4/submit

### Description
Creates a video generation job and returns a request ID for polling status and retrieving the final result.

### Method
POST

### Endpoint
https://prod.aicloudnetservices.com/api/external/video_v4/submit

### Parameters
#### Request Body
- **aspect** (string) - Optional - Output aspect ratio for the generated video. Default: "Portrait". Enum: "Portrait", "Landscape", "Square".
- **audioEnabled** (boolean) - Optional - Whether audio should be enabled for the generated video. Default: false.
- **prompt** (string) - Required - Text prompt used to guide video generation.
- **style** (string) - Optional - Video style/model preset. Default: "Real".
- **weight_slider** (number) - Optional - Controls the body weight of the subject. Range: -1 to 1.
- **breast_slider** (number) - Optional - Controls the breast size of the subject. Range: -1 to 1.
- **ass_slider** (number) - Optional - Controls the ass size of the subject. Range: -1 to 1.
- **age_slider** (integer) - Optional - Controls the perceived age of the subject. Minimum: 18.
- **seed** (integer) - Optional - Seed for deterministic results.
- **pose** (string) - Optional - Pose preset applied during generation. Default: "Default".

### Request Example
{
  "aspect": "Portrait",
  "audioEnabled": false,
  "prompt": "a cinematic portrait of a blonde woman looking at the camera, soft studio lighting",
  "style": "Photo XL+ v2",
  "weight_slider": 0.3,
  "breast_slider": -0.2,
  "ass_slider": 0.1,
  "age_slider": 24,
  "seed": 420,
  "pose": "Default"
}

### Response
#### Success Response (200)
- **request_id** (string) - The request ID for the submitted job.

#### Response Example
{
  "request_id": "2Mzyf80qgIj2j9nAwlal"
}
```

--------------------------------

### Retrieve completed video result

Source: https://promptchan.com/docs

Response format containing the final video URL and metadata upon successful completion.

```json
{
  "gems": 999860.45,
  "message": "Data received and processed",
  "status": "success",
  "video": [
    "https://storage.googleapis.com/temp-ie34w60fz7mc6nge/temp/videos/2MsCsX6EyTOmTFzHRBe9.mp4?Expires=1776420438&GoogleAccessId=firebase-adminsdk-jjn1g%40promptchan-fe814.iam.gserviceaccount.com&Signature=example"
  ]
}
```

--------------------------------

### Submit request response

Source: https://promptchan.com/docs

Successful response containing the request ID for tracking.

```json
{
  "request_id": "2Mzyf80qgIj2j9nAwlal"
}
```

--------------------------------

### POST /api/external/chat

Source: https://promptchan.com/docs

Sends a message to the AI companion and receives a response along with updated chat history.

```APIDOC
## POST /api/external/chat

### Description
Handles chat interactions with an AI companion, supporting roleplay modes and message redos.

### Method
POST

### Endpoint
https://prod.aicloudnetservices.com/api/external/chat

### Request Body
- **message** (string) - Required - User's message to the AI companion.
- **characterData** (object) - Required - Character profile information used to personalize responses.
- **chatHistory** (Array of objects) - Required - Previous messages exchanged between the user and the AI.
- **isRoleplay** (boolean) - Required - Indicates if the conversation is in roleplay mode.
- **redo** (boolean) - Required - If true, requests a redo of the last AI response instead.
- **userName** (string) - Required - The name of the user.

### Request Example
{
  "message": "string",
  "characterData": {
    "name": "string",
    "personality": "string",
    "scenario": "string",
    "sexuality": "string",
    "openness": 0,
    "emotions": 0,
    "age": 0,
    "gender": "string"
  },
  "chatHistory": [
    {
      "role": "string",
      "content": "string"
    }
  ],
  "isRoleplay": true,
  "redo": true,
  "userName": "string"
}

### Response
#### Success Response (200)
- **audio** (string) - Audio response from the AI.
- **chatHistory** (Array of objects) - Updated chat history.
- **message** (string) - The text response from the AI.
- **selfie** (string) - Generated image/selfie content.

#### Response Example
{
  "audio": "string",
  "chatHistory": [
    {
      "role": "string",
      "content": "string",
      "send_date": "2019-08-24T14:15:22Z"
    }
  ],
  "message": "string",
  "selfie": "string"
}
```

--------------------------------

### Image Generation Response Schema

Source: https://promptchan.com/docs

JSON structure returned upon a successful image generation request.

```json
{
  "image": "string",
  "gems": 0
}
```

--------------------------------

### Chat Request Payload

Source: https://promptchan.com/docs

The JSON structure required for sending messages to the AI companion.

```json
{
  "message": "string",
  "characterData": {
    "name": "string",
    "personality": "string",
    "scenario": "string",
    "sexuality": "string",
    "openness": 0,
    "emotions": 0,
    "age": 0,
    "gender": "string"
},
  "chatHistory": [
    {
      "role": "string",
      "content": "string"
}
],
  "isRoleplay": true,
  "redo": true,
  "userName": "string"

}
```

--------------------------------

### Image Generation Request Payload

Source: https://promptchan.com/docs

JSON structure for the POST request to the image generation endpoint.

```json
{
  "style": "Cinematic",
  "poses": "Default",
  "filter": "Default",
  "emotion": "Default",
  "detail": null,
  "prompt": "string",
  "seed": 0,
  "quality": "Ultra",
  "creativity": 0,
  "image_size": "512x512",
  "negative_prompt": "string",
  "restore_faces": true,
  "age_slider": 0,
  "weight_slider": null,
  "breast_slider": null,
  "ass_slider": null
}
```

--------------------------------

### Chat Response Payload

Source: https://promptchan.com/docs

The JSON structure returned by the server upon a successful chat interaction.

```json
{
  "audio": "string",
  "chatHistory": [
    {
      "role": "string",
      "content": "string",
      "send_date": "2019-08-24T14:15:22Z"
}
],
  "message": "string",
  "selfie": "string"

}
```
Tokens:
Raw