API Reference
Generate By Text
masterpiece, cinematic, man smoking cigarette looking outside window, moving around⭐️ Please use the returned uuid and endpoint /status to check your task's progress and to obtain the file link.
Endpoint
POST /runway/text
Request Headers
| Header | Value |
|---|---|
| x-api-key | YOUR_API_KEY |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| prompt | string | Yes | Text description of the video you want to generate |
| negative_prompt | string | No | Things you don't want to see in the generated video |
Response
{
"status": "success",
"message": "Task created successfully",
"data": {
"uuid": "12345678-1234-5678-1234-567812345678"
}
}Generate By Image
// Image file should be less than 10MB⭐️ Please use the returned uuid and endpoint /status to check your task's progress and to obtain the file link.
Endpoint
POST /runway/image
Request Headers
| Header | Value |
|---|---|
| x-api-key | YOUR_API_KEY |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| image | file | Yes | Image file to generate video from |
| negative_prompt | string | No | Things you don't want to see in the generated video |
Response
{
"status": "success",
"message": "Task created successfully",
"data": {
"uuid": "12345678-1234-5678-1234-567812345678"
}
}Generate By Image And Description
// Image file should be less than 10MB
// Example prompt: "A man walking in the rain"⭐️ Please use the returned uuid and endpoint /status to check your task's progress and to obtain the file link.
Endpoint
POST /runway/image-desc
Request Headers
| Header | Value |
|---|---|
| x-api-key | YOUR_API_KEY |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| image | file | Yes | Image file to generate video from |
| prompt | string | Yes | Text description of the desired video |
| negative_prompt | string | No | Things you don't want to see in the generated video |
Response
{
"status": "success",
"message": "Task created successfully",
"data": {
"uuid": "12345678-1234-5678-1234-567812345678"
}
}Generate By Video
// Video file should be less than 100MB
// Supported formats: MP4, MOV, AVI⭐️ Please use the returned uuid and endpoint /status to check your task's progress and to obtain the file link.
Endpoint
POST /runway/video
Request Headers
| Header | Value |
|---|---|
| x-api-key | YOUR_API_KEY |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| video | file | Yes | Video file to process |
| negative_prompt | string | No | Things you don't want to see in the generated video |
Response
{
"status": "success",
"message": "Task created successfully",
"data": {
"uuid": "12345678-1234-5678-1234-567812345678"
}
}Extend Video
// Video file should be less than 100MB
// Supported formats: MP4, MOV, AVI
// The video will be extended by 2 seconds⭐️ Please use the returned uuid and endpoint /status to check your task's progress and to obtain the file link.
Endpoint
POST /runway/extend
Request Headers
| Header | Value |
|---|---|
| x-api-key | YOUR_API_KEY |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| video | file | Yes | Video file to extend |
| negative_prompt | string | No | Things you don't want to see in the extended part |
Response
{
"status": "success",
"message": "Task created successfully",
"data": {
"uuid": "12345678-1234-5678-1234-567812345678"
}
}Get Task Status
// Use the UUID returned from previous API callsEndpoint
GET /status/{uuid}
Request Headers
| Header | Value |
|---|---|
| x-api-key | YOUR_API_KEY |
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| uuid | string | Task UUID returned from generation endpoints |
Response
{
"status": "success",
"message": "Task completed",
"data": {
"status": "completed",
"progress": 100,
"url": "https://storage.artvisum.com/videos/output.mp4",
"preview_url": "https://storage.artvisum.com/videos/preview.gif"
}
}