Update an agent in a FlowAI project

PATCH

https://example.itential.io/agent-project-service/agents/:agentId

PATCH

/agent-project-service/agents/:agentId

$ curl -X PATCH https://example.itential.io/agent-project-service/agents/agentId \
>      -H "Content-Type: application/json" \
>      -u "<username>:<password>" \
>      -d '{}'

1 {
2   "message": "string",
3   "data": {
4     "_id": "string",
5     "name": "string",
6     "description": "string",
7     "instructions": "string",
8     "inputSchema": {},
9     "created": "2024-01-15T09:30:00Z",
10     "createdBy": {
11       "_id": "string",
12       "username": "string",
13       "provenance": "string"
14     },
15     "lastUpdated": "2024-01-15T09:30:00Z",
16     "lastUpdatedBy": {
17       "_id": "string",
18       "username": "string",
19       "provenance": "string"
20     },
21     "operators": [
22       {
23         "_id": "string",
24         "name": "string",
25         "provenance": "string"
26       }
27     ],
28     "namespace": {
29       "type": "string",
30       "_id": "string",
31       "name": "string"
32     },
33     "authorized": true,
34     "tools": [
35       {
36         "decoratorId": "string",
37         "lastKnownName": "string",
38         "referenceId": "string"
39       }
40     ],
41     "provider": null
42   }
43 }

Updates an Agent Definition within a FlowAI Project. Requires editor or owner GBAC role; updating operators requires owner GBAC role.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

agentIdstringRequiredformat: "uuid"

Agent _id (UUID).

Request

request body

namestringOptionalformat: "^\S(.*\S)?$"1-100 characters

descriptionstringOptional<=500 characters

promptobjectOptional

providerobjectOptional

addToolslist of objectsOptional

decorateToolslist of objectsOptional

authorizeToolslist of objectsOptional

removeToolslist of objectsOptional

operatorslist of stringsOptional

Response

The updated Agent Definition

messagestring

dataobject

Errors

500

Internal Server Error