For the complete documentation index, see llms.txt. This page is also available as Markdown.

Formulas

Return a list of all formulas.

get

Returns a paginated list of formulas owned by the current user. Optionally filter by policy ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
policyIdstringOptional

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Responses
get
/formulas

Creates a new formula.

post

Creates a new formula linked to a policy. The formula defines calculation logic using variables, constants, and mathematical expressions that reference schema fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
Responses
201

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
post
/formulas

Retrieves formula by ID.

get

Returns the full formula object including config with variables, constants, and expressions. Returns additional fields compared to the list endpoint (uuid, createDate, updateDate, messageId, config).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
formulaIdstringRequired

Formula Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
get
/formulas/{formulaId}

Updates formula.

put

Updates formula configuration for the specified formula ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
formulaIdstringRequired

Formula Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Body
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
Responses
put
/formulas/{formulaId}

Deletes the formula.

delete

Deletes the formula with the provided ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
formulaIdstringRequired

Formula Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
delete
/formulas/{formulaId}

Retrieves Formula relationships.

get

Retrieves Formula relationships for the specified ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
formulaIdstringRequired

Formula Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
get
/formulas/{formulaId}/relationships

Imports new formula from a zip file.

post

Imports new formula from the provided zip file into the local DB.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Body
stringOptional
Responses
201

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
post
/formulas/{policyId}/import/file

Returns a zip file containing formula.

get

Returns a zip file containing formula.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
formulaIdstringRequired

Formula Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
get
/formulas/{formulaId}/export/file

Imports a zip file containing formula.

post

Imports a zip file containing formula.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
stringOptional
Responses
post
/formulas/import/file/preview

Return formula to editing.

put

Return formula to editing for the specified formula ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
formulaIdstringRequired

Formula Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
put
/formulas/{formulaId}/draft

Dry Run formula.

put

Run formula without making any persistent changes or executing transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
formulaIdstringRequired

Formula Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
put
/formulas/{formulaId}/dry-run

Publishes formula.

put

Publishes formula for the specified formula ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
formulaIdstringRequired

Formula Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
put
/formulas/{formulaId}/publish

Retrieves formulas and associated data.

post

Retrieves formulas and their associated data based on the provided options.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
schemaIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
documentIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
parentIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
Responses
201

Successful operation.

application/json
post
/formulas/data

Last updated