PixApi

Generate (PikaArt 1.0)

POST

https://api.pixapi.pro/api/generate

Last modified:2024-12-23 06:17:49

Generate a video from text and optional attachments

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.pixapi.pro/api/generate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ai": "pika1.0",
    "accountId": null,
    "rotationGroupId": 1,
    "styleId": null,
    "promptText": "3D render",
    "imageOrVideoUrl": "https://img.freepik.com/premium-photo/natural-beauty-portrait-woman-autumn-forest_1351942-2475.jpg",
    "sfx": true,
    "options": {
        "aspectRatio": "16:9",
        "frameRate": 24,
        "camera": {
            "pan": "right",
            "tilt": "up",
            "rotate": "cw",
            "zoom": "in"
        },
        "parameters": {
            "guidanceScale": 12,
            "motion": 1,
            "negativePrompt": "",
            "seed": null
        },
        "extend": false
    },
    "webhookUrl": "https://example.com/api/result"
}'

Response Example

{
  "error": false,
  "message": null,
  "data": {
    "jobId": "26e923fd-f302-487c-81fd-163466244b1a",
    "jobStatus": "new",
    "payload": {
      "ai": "pika1.0",
      "accountId": 11374,
      "rotationGroupId": null,
      "styleId": null,
      "promptText": "3D render",
      "imageOrVideoUrl": "media/ekCupWyvIETGahW-natural-beauty-portrait-woman-autumn-forest_1351942-2475.jpg",
      "sfx": true,
      "options": {
        "aspectRatio": "16:9",
        "frameRate": 24,
        "camera": {
          "pan": "right",
          "tilt": "up",
          "rotate": "cw",
          "zoom": "in"
        },
        "parameters": {
          "guidanceScale": 12,
          "motion": 1,
          "negativePrompt": null,
          "seed": null
        },
        "extend": false
      },
      "webhookUrl": "https://example.com/api/result"
    },
    "generationError": null,
    "resultError": null,
    "generationResponse": {
      "id": "cb5e6213-5395-4529-98da-6c557ece9279",
      "generation": {
        "id": "cb5e6213-5395-4529-98da-6c557ece9279",
        "promptText": "3D render",
        "params": {
          "options": {
            "aspectRatio": null,
            "frameRate": 24,
            "camera": {
              "zoom": null,
              "pan": null,
              "tilt": null,
              "rotate": null
            },
            "parameters": {
              "motion": 1,
              "guidanceScale": 12,
              "negativePrompt": "",
              "seed": null
            },
            "extend": false
          },
          "userId": "381e8dbc-4893-4bff-9a12-c7bbe573d912",
          "promptText": "3D render",
          "sfx": false,
          "styleId": null,
          "model": "1.0"
        },
        "adjusted": false,
        "upscaled": false,
        "extended": 0,
        "hasSfx": false,
        "lipSynced": false,
        "videos": [
          {
            "id": "cb5e6213-5395-4529-98da-6c557ece9279",
            "status": "queued"
          }
        ]
      }
    },
    "resultResponse": []
  }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

enum<string>

required

AI model

Allowed values:

pika1.0pika1.5pika2.0pv

accountId

integer | null

optional

Send a request for generation using the specified account.

rotationGroupId

integer | null

optional

Send a request for generation using the rotation group. In this case, specifying the accountId is not required – PixApi will automatically switch the account within the group every N requests.

imageOrVideoUrl

string | null

optional

A image or video url to generate the video from, must be a valid .png, .jpeg, .webp, .gif or .mp4 file.

styleId

enum<integer> | enum<null>

optional

Only for videos

Allowed values:

1234567

promptText

string

required

The text to create a video from

options

object

required

Options are a required parameter for every request. They are used to configure the video generation

aspectRatio

string | null

required

The aspect ration of the video, must be one of: "16:9", "9:16", "1:1", "5:2", "4:5", "4:3"

frameRate

integer

required

The frame rate for the video: Value must be between 1 and 24

camera

object

required

The camera settings for the video

parameters

object

required

Parameters is a required parameter for Options

extend

boolean

required

webhookUrl

string | null

optional

Override the webhook URL to which the generation result will be sent.

sfx

boolean

optional

Enable sound effects if set to 'true'. Default value is 'true'

Examples

Responses

🟢200Success

application/json

Body

object {0}

Modified at 2024-12-23 06:17:49

Get rotation groups

Generate (PikaArt 1.5)