POST
/
v1
/
prompt_engine
/
run
import { JigsawStack } from "jigsawstack";

const jigsawstack = JigsawStack({
apiKey: "your-api-key",
});

const result = await jigsawstack.prompt_engine.run_prompt_direct({
prompt: "Tell me a story about {about}",
inputs: [
{
key: "about",
optional: false,
initial_value: "Leaning Tower of Pisa",
},
],
return_prompt: "Return the result in a markdown format",
prompt_guard: ["sexual_content", "defamation"],
input_values: {
about: "Santorini",
},
});


{
  "success": true,
  "result": "Once upon a time, in the beautiful city of Pisa, Italy, there stood a magnificent tower that would become known as the Leaning Tower of Pisa. The tower was originally built as a bell tower for the nearby cathedral, and construction began in 1173.\n\nHowever, as the tower began to rise higher and higher, it became clear that there was a problem - the tower was leaning to one side. The soft ground beneath the tower was unable to support its weight, causing it to tilt at an angle. Despite efforts to correct the lean during construction, the tower continued to lean as it was completed in 1372.\n\nOver the centuries, the Leaning Tower of Pisa became a famous landmark and a symbol of Italy. Tourists from all over the world flocked to Pisa to see the tower and take pictures of themselves pretending to hold it up or push it over.\n\nDespite its precarious lean, the tower has managed to stand for over 800 years, thanks to various engineering efforts to stabilize it. In the 20th century, further measures were taken to prevent the tower from toppling over, including removing soil from underneath the tower and installing counterweights.\n\nToday, the Leaning Tower of Pisa remains one of the most iconic and beloved landmarks in Italy, attracting millions of visitors each year who marvel at its unique tilt and the incredible feat of engineering that has kept it standing for so long. It serves as a reminder that even the most flawed and imperfect structures can still be beautiful and enduring."
}
Run Prompt Direct is ideal for one-time prompt usage.

For prompts that will be used multiple times, it is recommended to first Create a Prompt and then Run the Prompt for better reliability.

​
x-api-key
string
required

Your JigsawStack API key

​
Body

​
prompt
string
required

The prompt. Maximum character limit is 500000. Prompt supports dynamic inputs. See example below.

​
inputs
array<object>

The prompt inputs. See example below.

​
return_prompt
string | array | object

How the prompt result should be returned or formatted. See examples below

​
prompt_guard
array<string>

Include this to guard against unsafe inputs from users. Supported values:

  • defamation
  • privacy
  • hate
  • sexual_content
  • elections
  • code_interpreter_abuse
  • indiscrimate_weapons
  • specialized_advice
​
input_values
object

Key-value pair for dynamic prompt variables. Each input value has a 500000 character limit

​
stream
boolean

If set, partial message chunk will be sent.

​
use_internet
boolean

Include this to allow prompt engine to use the internet.

​
Sample Prompt Payload

  • String return_prompt
{
    prompt: "Tell me a story about {about}",
    inputs: [
      {
        key: "about",
        optional: false,
      },
    ],
    return_prompt: "Return the result in a markdown format",
    "prompt_guard": ["sexual_content", "defamation"]
    "input_values": {
      "about": "Santorini",
    }
  }
  • Array<object> return_prompt

{
    prompt: "Tell me a story about {about}",
    inputs: [
      {
        key: "about",
        optional: false,
        initial_value: "Leaning Tower of Pisa",
      },
    ],
    return_prompt: [{ excerpt: "short story text", summary: "summary of story" }],
    "prompt_guard": ["sexual_content", "defamation"],
    "input_values": {
      "about": "Santorini",
    }
  }
  • Object return_prompt
{
    prompt: "Tell me a story about {about}",
    inputs: [
      {
        key: "about",
        optional: false,
        initial_value: "Leaning Tower of Pisa",
      },
    ],
    return_prompt: { excerpt: "short story text", summary: "summary of story" },
    "prompt_guard": ["sexual_content", "defamation"],
    "input_values": {
      "about": "Santorini",
    }
  }

​
Response

​
success
boolean

Indicates whether the call was successful.

import { JigsawStack } from "jigsawstack";

const jigsawstack = JigsawStack({
apiKey: "your-api-key",
});

const result = await jigsawstack.prompt_engine.run_prompt_direct({
prompt: "Tell me a story about {about}",
inputs: [
{
key: "about",
optional: false,
initial_value: "Leaning Tower of Pisa",
},
],
return_prompt: "Return the result in a markdown format",
prompt_guard: ["sexual_content", "defamation"],
input_values: {
about: "Santorini",
},
});


{
  "success": true,
  "result": "Once upon a time, in the beautiful city of Pisa, Italy, there stood a magnificent tower that would become known as the Leaning Tower of Pisa. The tower was originally built as a bell tower for the nearby cathedral, and construction began in 1173.\n\nHowever, as the tower began to rise higher and higher, it became clear that there was a problem - the tower was leaning to one side. The soft ground beneath the tower was unable to support its weight, causing it to tilt at an angle. Despite efforts to correct the lean during construction, the tower continued to lean as it was completed in 1372.\n\nOver the centuries, the Leaning Tower of Pisa became a famous landmark and a symbol of Italy. Tourists from all over the world flocked to Pisa to see the tower and take pictures of themselves pretending to hold it up or push it over.\n\nDespite its precarious lean, the tower has managed to stand for over 800 years, thanks to various engineering efforts to stabilize it. In the 20th century, further measures were taken to prevent the tower from toppling over, including removing soil from underneath the tower and installing counterweights.\n\nToday, the Leaning Tower of Pisa remains one of the most iconic and beloved landmarks in Italy, attracting millions of visitors each year who marvel at its unique tilt and the incredible feat of engineering that has kept it standing for so long. It serves as a reminder that even the most flawed and imperfect structures can still be beautiful and enduring."
}

Was this page helpful?

Suggest editsRaise issue