Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
ai-hint

Create a hint

post/v1/ai-hint

Request body

namestring required

unique name for this hint

toolNamestring

tool name this hint applies to, e.g. Create, Update, Delete, DataExplorer

entityTypestring

entity type this hint applies to, e.g. ACTION, FORM, REPORT

keywordsstring[]

keywords that trigger this hint when matched in user messages

schemastring

optional schema override; if null, auto-generated from the entity adapter's create class

addHintIdsstring[]

additional hint ids to include when this hint is surfaced

contentstring required

the hint content to provide to the AI

Example request

{
  "addHintIds": [
    "588f7ee98f138b19220041a7"
  ]
}

Response

successful operation

idstring required

globally unique id

namestring required

unique name for this hint

toolNamestring

tool name this hint applies to, e.g. Create, Update, Delete, DataExplorer

entityTypestring

entity type this hint applies to, e.g. ACTION, FORM, REPORT

keywordsstring[]

keywords that trigger this hint when matched in user messages

schemastring

optional schema override; if null, auto-generated from the entity adapter's create class

addHintIdsstring[]

additional hint ids to include when this hint is surfaced

contentstring

the hint content to provide to the AI

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "addHintIds": [
    "588f7ee98f138b19220041a7"
  ],
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z"
}