Functions

Functions are reusable code blocks that perform specialized tasks. Agents or external calls can invoke these functions to automate complex operations effortlessly.

List functions

Retrieve all functions created on the platform. Functions can be linked to agents to enable specialized operations.

GEThttps://api.aver.co/v1/functions

Response

200500

List of functions retrieved successfully.

Body

application/json

idstring

Example: "function_abcde"

namestring

Example: "analyzeMarket"

descriptionstring

Example: "Analyzes market data and returns insights."

codestring

Example: "function analyzeMarket(data) { /* ... */ }"

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/functions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": "function_abcde",
    "name": "analyzeMarket",
    "description": "Analyzes market data and returns insights.",
    "code": "function analyzeMarket(data) { /* ... */ }"
  }
]

Create a function

Add a new function that can be executed by an agent.

POSThttps://api.aver.co/v1/functions

Body

application/json

name*string

descriptionstring

codestring

Actual code for the function.

Response

201400500

Function created successfully.

Body

application/json

idstring

Example: "function_abcde"

namestring

Example: "analyzeMarket"

descriptionstring

Example: "Analyzes market data and returns insights."

codestring

Example: "function analyzeMarket(data) { /* ... */ }"

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/functions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": "function_abcde",
  "name": "analyzeMarket",
  "description": "Analyzes market data and returns insights.",
  "code": "function analyzeMarket(data) { /* ... */ }"
}

Fetch function by ID

Retrieve details about a specific function, including its code, parameters, and usage statistics.

GEThttps://api.aver.co/v1/functions/{id}

Path parameters

id*string

The unique identifier of the function.

Response

200404500

Function details retrieved successfully.

Body

application/json

idstring

Example: "function_abcde"

namestring

Example: "analyzeMarket"

descriptionstring

Example: "Analyzes market data and returns insights."

codestring

Example: "function analyzeMarket(data) { /* ... */ }"

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/functions/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "function_abcde",
  "name": "analyzeMarket",
  "description": "Analyzes market data and returns insights.",
  "code": "function analyzeMarket(data) { /* ... */ }"
}

Update a function

Edit the metadata or code of an existing function.

PATCHhttps://api.aver.co/v1/functions/{id}

Path parameters

id*string

The unique identifier of the function.

Body

application/json

descriptionstring

codestring

Response

200400404500

Function updated successfully.

Body

application/json

idstring

Example: "function_abcde"

namestring

Example: "analyzeMarket"

descriptionstring

Example: "Analyzes market data and returns insights."

codestring

Example: "function analyzeMarket(data) { /* ... */ }"

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/functions/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "function_abcde",
  "name": "analyzeMarket",
  "description": "Analyzes market data and returns insights.",
  "code": "function analyzeMarket(data) { /* ... */ }"
}

Delete a function

Remove a function by its unique identifier.

DELETEhttps://api.aver.co/v1/functions/{id}

Path parameters

id*string

The unique identifier of the function.

Response

204404500

Function deleted successfully. No content in response.

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/functions/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Invoke a function directly

Execute the specified function without linking it to an agent. Useful for quick testing or external usage.

POSThttps://api.aver.co/v1/functions/{id}/invoke

Path parameters

id*string

The unique identifier of the function.

Body

application/json

inputDataobject

Input needed for the function.

Response

200400404500

Function invoked successfully.

Body

application/json

resultobject

Output of the executed function.

messagestring

Example: "Function executed successfully."

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/functions/{id}/invoke', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "message": "Function executed successfully."
}