DeltaV Function Groups API

Most of the endpoints depends on various instances and are considered parameters for the actual endpoint, but these are not meant to be passed directly by the user.

Instead, these instance-dependent elements are integrated and managed directly by the backend system. We refer to them as *name_parameter, where the asterisk (*) is used to denote a specific instance-dependent parameter that the route relies on.

Mind that: to access these APIs, user must be authenticated and have the correct permissions.

Overview

The DeltaV Function Groups API allows you to interact with the DeltaV backend, allowing you to interact with your function groups and more.

Endpoints

POST /v1beta1/function-groups/
 
GET /v1beta1/function-groups/
 
GET /v1beta1/function-groups/:function_group_id/functions/
 
GET /v1beta1/function-groups/public/
 
DELETE /v1beta1/function-groups/:function_group_id/

Create a function group

Endpoint: POST /v1beta1/function-function-group/

Request

Create a new function group for a user authenticated through JWT.

Name
name
Type
string
Description
The name of the function group.
Name
isPrivate
Type
boolean
Description
Whether the function group is private or not.

bash

curl \
-X POST \
-H Authorization: bearer <your token here> \
https://agentverse.ai/v1beta1/function-function-group/ \
 -d '{"name":"Function group 1","isPrivate":true}'

Responses

Returns the newly created FunctionGroup object.

json

{
  "uuid": "d65b0137-bd3a-4d36-995a-b75b2cb81ba9",
  "name": "Function group 1",
  "isPrivate": true
}

Get all function groups of a user

Endpoint: GET /v1beta1/function-groups/

Request

Get all function groups of a user authenticated through JWT.

bash

curl \
-X GET \
-H Authorization: bearer <your token here> \
https://agentverse.ai/v1beta1/function-groups/

Responses

Returns an list of function group objects.

json

[
  {
    "uuid": "13373a38-db6c-4805-ae9e-33ae5f9a08c1",
    "name": "Test group 1",
    "isPrivate": false
  },
  {
    "uuid": "207c7895-db9d-434e-b38e-6249ca67d63e",
    "name": "Test group 2",
    "isPrivate": false
  }
]

Get functions of a function group

Endpoint: GET /v1beta1/function-function-group/{function_group_id}/functions/

Request

Get functions of a function group for a user authenticated through JWT.

bash

curl \
-X GET \
-H Authorization: bearer <your token here> \
https://agentverse.ai/v1beta1/function-function-group/{function_group_id}/functions/

Responses

Returns an JSON containing the function group and a list of function names.

json

{
  "function_group": "d65b0137-bd3a-4d36-995a-b75b2cb81ba9",
  "functions": [
    "function 1",
    "function 2"
  ]
}

Get all public function groups

Endpoint: GET /v1beta1/function-groups/public/

Request

Get all public function groups.

bash

curl \
-X GET \
-H Authorization: bearer <your token here> \
https://agentverse.ai/v1beta1/function-groups/public/

Responses

Returns an list of FunctionGroup objects.

json

[
  {
    "uuid": "13373a38-db6c-4805-ae9e-33ae5f9a08c1",
    "name": "Test group 1",
    "isPrivate": false
  },
  {
    "uuid": "207c7895-db9d-434e-b38e-6249ca67d63e",
    "name": "Test group 2",
    "isPrivate": false
  }
]

Delete a function group

Endpoint: DELETE /v1beta1/function-function-group/{function_group_id}/

Request

Delete a function group for a user authenticated through JWT.

bash

curl \
-X DELETE \
-H Authorization: bearer <your token here> \
https://agentverse.ai/v1beta1/function-function-group/{function_group_id}/

Responses

Returns an empty JSON object.

json

{}

Was this page helpful?

Functions API