Skip to main content
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 {companyName} is relevant based on {jobTitle} and {lastLinkedInPost}.",
  "search": true
}
'
{
  "status": "success",
  "message": "<string>",
  "data": {
    "id": 123,
    "name": "<string>",
    "prompt": "<string>",
    "model": "<string>",
    "outputSchema": {
      "type": "text",
      "values": [
        "<string>"
      ],
      "provideExplanation": true,
      "jsonSchema": "<string>"
    },
    "search": true,
    "entity": "CONTACT",
    "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
​
name
string

New AI variable name.

Minimum string length: 1
​
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 valid field names.

Minimum string length: 1
​
model
string | null

Optional new model ID.

​
outputSchema
object

Optional new output contract.

​
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