Get an AI action

GET

/api/v1/ai/actions/{actionId}

const url = 'https://app.avera.io/api/v1/ai/actions/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.avera.io/api/v1/ai/actions/example

Parameters

Path Parameters

actionId

required

string

Responses

200

*/*

object

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