Prompts

Prompts are how the script for your video gets generated. Usually these are written from an initial description of the video generator you'd like to create.

The scripts generated from these are then executed in a Script, generating the video and audio to match the description of the output from the Prompt.

The Prompt model

The Prompt model allows for the prompt for videos to be generated with.

Properties

Name
project_id
Type
string
Description
Name of the project the script is associated with.
Name
inputs
Type
string
Description
Required inputs for generation of a video.
Name
value
Type
object
Description
Graph of the generation process.

GET/prompts

List all prompts

This endpoint allows you to retrieve a list of all prompts for a project.

Optional attributes

Name
limit
Type
integer
Description
Limit the number of prompts returned.

Request

GET

/prompts

curl -G https://api.video-jungle.com/prompts
  -H "Authorization: Bearer {token}" \
  -d limit=10

Response

[    
{
"persona": "",
"value": "You are an AI that performs I Ching readings...",
"creator_id": "612afec9-bcb2-47ca-807b-756d6e83b4b7",
"parameters": [
  "question"
],
"name": "you are an i ching reader who rolls a set of coins, and interprets the readings in response to the user's question",
"variables": null,
"id": "cdf82262-ae82-4d86-a837-01b5e070b592",
"created_at": "2024-07-16T12:12:39.961821",
"task": null,
"project_id": "2ec097cd-1fff-4824-a7bf-a0e14281f4e5",
"project": {
  "data": "",
  "id": "2ec097cd-1fff-4824-a7bf-a0e14281f4e5",
  "name": "Claude I Ching",
  "description": "Claude Generated I Ching",
  "created_at": "2024-07-16T12:13:05.899678",
  "owner_id": "612afec9-bcb2-47ca-807b-756d6e83b4b7"
},
}
// ...
]

POST/prompts/generate

Generate a Prompt from task

This endpoint allows you to generate a prompt according to a task description and a list of variables for the prompt.

Required attributes

Name
task
Type
string
Description
Describe the type of video generator you'd like created. This will then be created and available for editing later.
Name
variables
Type
array
Description
A list of strings, each a descriptive name for your variables for video generation.

Request

POST

/prompts/generate

curl -G https://api.video-jungle.com/prompts/generate
  -H "Authorization: Bearer {token}" \
  -d task="you generate i ching readings"
  -d variables=['date', 'question']

Response

{
    "id": "ffff-ffff-ffff-ffff",
    "name": "you generate i ching readings",
}