Create Task - Luma API

Request

Header Params

x-api-key

string

required

Your API Key used for request authorization

Body Params application/json

model

enum<string>

required

the model name

Allowed value:

luma

task_type

enum<string>

required

type of the task

Allowed values:

video_generationextend_video

input

object

required

the input param of the luma task

prompt

string

required

The prompt is a description that enables the Dream Machine API to produce a video.

key_frames

object

optional

If left null then the task would be a text-to-video task; if filled out, then the task would be an image-to-video or video-extend task.

In an image-to-video task, the type of the frame can only be set to image, you can choose to set to frame0 and/or frame1.

model_name

enum<string>

optional

default is ray-v1;

Allowed values:

ray-v1ray-v2

duration

enum<integer>

optional

default is 5; 10 can only be used in txt2video

Allowed values:

510

aspect_ratio

enum<string>

optional

default is 16:9

Allowed values:

9:163:41:14:316:921:9

config

object

optional

webhook_config

object

optional

Webhook provides timely task notifications. Check PiAPI webhook for detail.

service_mode

enum<string>

optional

This allows users to choose whether this specific task will get processed under PAYG or HYA mode. If unspecified, then this task will get processed under whatever mode (PAYG or HYA)
the user chose on the workspace setting of your account.

public means this task will be processed under PAYG mode.

private means this task will be processed under HYA mode.

Allowed values:

publicprivate

Example

{
  "model": "luma",
  "task_type": "video_generation",
  "input": {
    "prompt": "Fly fishing",
    "key_frames": {
      "frame0": {
        "type": "laborum ad",
        "url": "https://glaring-fishery.com/",
        "id": "XFT5J9GBfGDm_iqe4z3oU"
      },
      "frame1": {
        "type": "do ex dolor ea",
        "url": "https://hungry-oil.org/"
      }
    },
    "model_name": "ray-v1",
    "duration": 5,
    "aspect_ratio": "9:16"
  },
  "config": {
    "webhook_config": {
      "endpoint": "",
      "secret": ""
    },
    "service_mode": ""
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.piapi.ai/api/v1/task' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "luma",
    "task_type": "video_generation",
    "input": {
        "prompt": "Fly fishing",
        "key_frames": {
            "frame0": {
                "type": "laborum ad",
                "url": "https://glaring-fishery.com/",
                "id": "XFT5J9GBfGDm_iqe4z3oU"
            },
            "frame1": {
                "type": "do ex dolor ea",
                "url": "https://hungry-oil.org/"
            }
        },
        "model_name": "ray-v1",
        "duration": 5,
        "aspect_ratio": "9:16"
    },
    "config": {
        "webhook_config": {
            "endpoint": "",
            "secret": ""
        },
        "service_mode": ""
    }
}'

Responses

🟢200Success

application/json

Body

code

integer

required

data

object

required

task_id

string

required

model

string

required

task_type

string

required

status

enum<string>

required

Hover on the "Completed" option and you coult see the explaintion of all status: completed/processing/pending/failed/staged

Allowed values:

CompletedProcessingPendingFailedStaged

input

object

required

output

object

required

meta

object

required

detail

null

required

logs

array [object]

required

error

object

required

message

string

required

If you get non-null error message, here are some steps you chould follow:

Check our common error message

Retry for several times

If you have retried for more than 3 times and still not work, file a ticket on Discord and our support will be with you soon.

Example

{
  "code": 200,
  "data": {
    "task_id": "f7a6d8e5-249f-4a9e-a8f4-1e8af806ea15",
    "model": "luma",
    "task_type": "video_generation",
    "status": "pending",
    "config": {
      "service_mode": "public",
      "webhook_config": {
        "endpoint": "",
        "secret": ""
      }
    },
    "input": {},
    "output": {
      "prompt": "",
      "internal_state": "",
      "created_at": "",
      "video": null,
      "video_raw": null,
      "thumbnail": null,
      "last_frame": null
    },
    "meta": {},
    "detail": null,
    "logs": null,
    "error": {
      "code": 0,
      "raw_message": "",
      "message": "",
      "detail": null
    }
  },
  "message": "success"
}