Skip to main content
POST
/
v1
/
studio
/
prompts
/
{promptId}
/
compile
Compile a prompt
curl --request POST \
  --url https://api.qualifire.ai/api/v1/studio/prompts/{promptId}/compile \
  --header 'Content-Type: application/json' \
  --header 'X-Qualifire-API-Key: <api-key>' \
  --data '
{
  "variables": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "revision": 123,
  "messages": [
    {
      "role": "<string>",
      "content": "<string>"
    }
  ],
  "tools": [
    {
      "type": "<string>",
      "function": {
        "name": "<string>",
        "description": "<string>",
        "parameters": {}
      }
    }
  ],
  "parameters": {}
}

Authorizations

X-Qualifire-API-Key
string
header
required

Path Parameters

promptId
string
required

Prompt ID (cuid) or textId (deprecated)

Query Parameters

revision
string

Revision ID (cuid) - preferred method

revisionNumber
string

Revision number (deprecated, use revision instead)

Body

application/json

Variables to substitute in the prompt

variables
object
required

Key-value map of variable names to their values

Response

OK

id
string
required
name
string | null
required
revision
integer
required
messages
object[]
required
tools
object[]
required
parameters
object
required