Skip to content
AveraAveraAvera Documentation

Create an AI action

POST
/api/v1/ai/actions
curl --request POST \
  --url https://app.avera.io/api/v1/ai/actions \
  --header 'Content-Type: application/json' \
  --data '{ "id": "example", "name": "example", "description": "example", "outputType": "PROPOSE_ITEM_ACTIONS", "sourceItemType": "example", "systemPrompt": "example", "contextTree": "example", "allowedActionTypes": [ "ATTRIBUTE_EDIT" ], "createableItemTypes": [ "example" ], "editableAttributes": [ "example" ], "usableRelationshipTypes": [ "example" ], "maxContextTokens": 1, "minConfidenceThreshold": 1, "preferredModel": "example", "temperature": 1, "maxOutputTokens": 1 }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
id
required
string
name
required
string
description
required
string
outputType
required
string
Allowed values: PROPOSE_ITEM_ACTIONS
sourceItemType
required
string
systemPrompt
required
string
contextTree
required
string
allowedActionTypes
required
Array<string>
unique items
Allowed values: ATTRIBUTE_EDIT RELATIONSHIP_ADD RELATIONSHIP_REMOVE RELATIONSHIP_SET ITEM_CREATE ITEM_DELETE ITEM_REVISION_ABANDON ITEM_STATE_TRANSITION RELATIONSHIP_SUSPECT_CLEAR OBSERVATION_ADD LIVEDOC_EDIT LIVEDOC_SECTION_INSERT LIVEDOC_SECTION_REPLACE LIVEDOC_SECTION_DELETE LIVEDOC_CONTENT_APPEND LIVEDOC_ITEM_REFERENCE_INSERT LIVEDOC_ITEM_EMBED_INSERT QUERY_TABLE_INSERT RESPONSE_RECORD
createableItemTypes
required
Array<string>
unique items
editableAttributes
required
Array<string>
unique items
usableRelationshipTypes
required
Array<string>
unique items
maxContextTokens
required
integer format: int32
minConfidenceThreshold
required
number format: float
preferredModel
string | null
temperature
required
number format: float
maxOutputTokens
required
integer format: int32

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
id
required
string
tenantId
required
string format: uuid
name
required
string
description
required
string
outputType
required
string
Allowed values: PROPOSE_ITEM_ACTIONS
sourceItemType
required
string
systemPrompt
required
string
contextTree
required
string
allowedActionTypes
required
Array<string>
unique items
Allowed values: ATTRIBUTE_EDIT RELATIONSHIP_ADD RELATIONSHIP_REMOVE RELATIONSHIP_SET ITEM_CREATE ITEM_DELETE ITEM_REVISION_ABANDON ITEM_STATE_TRANSITION RELATIONSHIP_SUSPECT_CLEAR OBSERVATION_ADD LIVEDOC_EDIT LIVEDOC_SECTION_INSERT LIVEDOC_SECTION_REPLACE LIVEDOC_SECTION_DELETE LIVEDOC_CONTENT_APPEND LIVEDOC_ITEM_REFERENCE_INSERT LIVEDOC_ITEM_EMBED_INSERT QUERY_TABLE_INSERT RESPONSE_RECORD
createableItemTypes
required
Array<string>
unique items
editableAttributes
required
Array<string>
unique items
usableRelationshipTypes
required
Array<string>
unique items
maxContextTokens
required
integer format: int32
minConfidenceThreshold
required
number format: float
preferredModel
string | null
temperature
required
number format: float
maxOutputTokens
required
integer format: int32
version
required
integer format: int32
status
required
string
createdAt
required
string format: date-time
createdBy
string | null format: uuid
modifiedAt
string | null format: date-time
modifiedBy
string | null format: uuid