curl --request PATCH \
  --url https://openapi.enginy.ai/v1/ai-variables/{aiVariableId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "prompt": "Summarize why {firstName} at {company} is relevant based on {jobTitle} and {lastLinkedInPost}.",
  "search": true
}
'

{
  "message": "<string>",
  "data": {
    "id": 123,
    "name": "<string>",
    "prompt": "<string>",
    "model": "<string>",
    "outputSchema": {
      "values": [
        "<string>"
      ],
      "provideExplanation": true,
      "jsonSchema": "<string>"
    },
    "search": true,
    "folderId": 123,
    "customWebsiteField": "<string>",
    "description": "<string>",
    "isPublic": true,
    "archivedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

AI Variables

Update an AI variable

Update an existing AI variable in the public/manual model. Prompt placeholders must come from the relevant fields endpoint output for this workspace; generic conversation placeholders such as previousMessage are not supported here.

When prompt is updated, Enginy regenerates the internal editor format from the new prompt text.

Use the contact/company fields endpoints as the source of truth for prompt placeholders. Do not assume campaign-only aliases like previousMessage are valid in manual/public AI-variable updates.

Required scope: AI_VARIABLES_WRITE

Rate limit: 30 requests per minute

PATCH

/

v1

/

ai-variables

/

{aiVariableId}

curl --request PATCH \
  --url https://openapi.enginy.ai/v1/ai-variables/{aiVariableId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "prompt": "Summarize why {firstName} at {company} is relevant based on {jobTitle} and {lastLinkedInPost}.",
  "search": true
}
'

{
  "message": "<string>",
  "data": {
    "id": 123,
    "name": "<string>",
    "prompt": "<string>",
    "model": "<string>",
    "outputSchema": {
      "values": [
        "<string>"
      ],
      "provideExplanation": true,
      "jsonSchema": "<string>"
    },
    "search": true,
    "folderId": 123,
    "customWebsiteField": "<string>",
    "description": "<string>",
    "isPublic": true,
    "archivedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

x-api-key

string

header

required

Path Parameters

aiVariableId

string

required

The AI variable ID

Body

application/json

prompt

string

New prompt template. Enginy regenerates the internal prompt representation from this value. Use GET /v1/contacts/fields or GET /v1/companies/fields to discover the valid placeholder names for this workspace. Unsupported generic placeholders such as {previousMessage} are rejected in manual/public AI-variable updates.

Minimum string length: 1

model

string | null

Optional new model ID.

outputSchema

object

Optional new output contract.

Show child attributes

search

boolean

Enable or disable Deep Search.

entity

enum<string>

Optional new entity.

Available options:

CONTACT,

COMPANY

folderId

integer | null

Optional new folder ID.

customWebsiteField

string | null

Optional new custom website field source.

Response

AI variable updated successfully

status

enum<string>

required

Available options:

success

message

string

required

data

object

required

Show child attributes

Delete an AI variable Get contact field metadata