POST
/
api
/
prompt
/
get-compiled
curl --request POST \
  --url http://localhost:3000/api/prompt/get-compiled \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: text/plain' \
  --data '{
  "name": "tester",
  "promptId": "a7a55e48-1588-44ee-99e2-d9de5c026238",
  "version": "1.0.0",
  "metaProperties": {},
  "compile": true,
  "variables": {
    "name": "John"
  }
}'
{
  "err": {},
  "res": {
    "promptId": "a7a55e48-1588-44ee-99e2-d9de5c026238",
    "versionId": "2d44f89a-2222-498d-869b-795296496ca3",
    "name": "tester",
    "version": "1.0.0",
    "tags": [
      "<string>"
    ],
    "metaProperties": {},
    "prompt": "Hello {{name}}",
    "compiledPrompt": "Hello John"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

text/plain
​
name
string
Example:

"tester"

​
promptId
string
Example:

"a7a55e48-1588-44ee-99e2-d9de5c026238"

​
version
string
Example:

"1.0.0"

​
metaProperties
object
​
compile
boolean
Example:

true

​
variables
object

Response

200 - application/json
Successfully retrieved compiled prompt.
​
err
object | null
​
res
object

Was this page helpful?

Suggest edits