GET
/
v1
/
prompt_engine
/
{id}
import { JigsawStack } from "jigsawstack";

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

const response = await jigsaw.prompt_engine.get({
  "id": "14d675d5-b309-463d-8906-1be65af74c43"
})
{
  "success": true,
  "id": "14d675d5-b309-463d-8906-1be65af74c43",
  "inputs": [
        {
              "key": "about",
              "optional": false
        }
  ],
  "prompt": "Tell me a story about {about}",
  "return_prompt": "Return the result in a markdown format",
  "created_at": "2025-04-11T21:34:29.434339+00:00",
  "prompt_guard": [
        "sexual_content",
        "defamation"
  ],
  "optimized_prompt": "Create a captivating story centered around the theme of {about}, incorporating vivid characters and an engaging plot.",
  "use_internet": false,
  "public": false,
  "name": null,
  "user_id": null,
  "public_status": null,
  "updated_at": "2025-04-11T21:34:29.434339+00:00",
  "_usage": {
        "input_tokens": 12,
        "output_tokens": 142,
        "inference_time_tokens": 774,
        "total_tokens": 928
  }
}
x-api-key
string
required

Your JigsawStack API key

Query

id
string

The prompt id.

Response

success
boolean

Indicates whether the call was successful.

import { JigsawStack } from "jigsawstack";

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

const response = await jigsaw.prompt_engine.get({
  "id": "14d675d5-b309-463d-8906-1be65af74c43"
})
{
  "success": true,
  "id": "14d675d5-b309-463d-8906-1be65af74c43",
  "inputs": [
        {
              "key": "about",
              "optional": false
        }
  ],
  "prompt": "Tell me a story about {about}",
  "return_prompt": "Return the result in a markdown format",
  "created_at": "2025-04-11T21:34:29.434339+00:00",
  "prompt_guard": [
        "sexual_content",
        "defamation"
  ],
  "optimized_prompt": "Create a captivating story centered around the theme of {about}, incorporating vivid characters and an engaging plot.",
  "use_internet": false,
  "public": false,
  "name": null,
  "user_id": null,
  "public_status": null,
  "updated_at": "2025-04-11T21:34:29.434339+00:00",
  "_usage": {
        "input_tokens": 12,
        "output_tokens": 142,
        "inference_time_tokens": 774,
        "total_tokens": 928
  }
}