Agents – ProteusAI Reference

🚫

Internal use only!

An agent is an entity that perceives its environment, takes actions autonomously to achieve goals, and may improve its performance through machine learning, human control or by acquiring knowledge. Most agents on ProteusAI are powered by AI but you can easily create agents controlled by humans.

Create Agent

POST /api/agents

curl https://management-api.useproteus.ai/api/agents \
    -X POST \
    -H "Authorization: Bearer user-3a4d80a9c3cca7ffd1bc341f.ede04d00e4b168bed35d9fcde8c2f92f.00d7fecf89201691f94b01e5b294da65.e7ea4c191b2c9a059ce5658deb7349c26a931ed8b7a04bf0" \
    -d '{
            "name": "My First Agent",
            "goal": "You are a helpful personal assistant. Always answer questions in a kind and helpful manner.",
            "orgId": "6816330b6f46b5afc080fbf7"
        }'

You can also create agents via the orgs API POST: /api/orgs/:orgId/agents. You will not be able to supply an orgId field in the request body.

curl https://management-api.useproteus.ai/api/orgs/6816330b6f46b5afc080fbf7/agents \
    -X POST \
    -H "Authorization: Bearer user-3a4d80a9c3cca7ffd1bc341f.ede04d00e4b168bed35d9fcde8c2f92f.00d7fecf89201691f94b01e5b294da65.e7ea4c191b2c9a059ce5658deb7349c26a931ed8b7a04bf0" \
    -d '{
            "name": "My First Public Agent",
            "goal": "You are a helpful public assistant. Always answer questions in a kind and helpful manner.",
            "isPublic": true
        }'

Get Agent

GET /api/agents/:agentId

This endpoint returns an agent.

curl https://management-api.useproteus.ai/api/agents/681998f5474dbe26fe2e7f5f \
    -H "Authorization: Bearer user-3a4d80a9c3cca7ffd1bc341f.ede04d00e4b168bed35d9fcde8c2f92f.00d7fecf89201691f94b01e5b294da65.e7ea4c191b2c9a059ce5658deb7349c26a931ed8b7a04bf0"

You have to be a member of an organization to view a non-public agent in that organization.

curl https://management-api.useproteus.ai/api/agents/681998f5474dbe26fe2e7f5f \
    -H "Authorization: Bearer user-73dd22b0c07a542d080d48a2.9e0ac60c1472a5f2949f8978e82d2582.dfbaf5a25782b0608e173d295e977259.2a52f18cf2ce3d84872ae7fc73c60822ad6fe0ad7dc21f58"

You do not have to be a member of an organization to view a public agent in that organization.

curl https://management-api.useproteus.ai/api/agents/6819a0e484df0fc342cea506 \
    -H "Authorization: Bearer user-73dd22b0c07a542d080d48a2.9e0ac60c1472a5f2949f8978e82d2582.dfbaf5a25782b0608e173d295e977259.2a52f18cf2ce3d84872ae7fc73c60822ad6fe0ad7dc21f58"

List Org Agents

GET /api/orgs/:orgId/agents

This endpoint fetches the agents in an organization.

curl https://management-api.useproteus.ai/api/orgs/6816330b6f46b5afc080fbf7/agents \
    -H "Authorization: Bearer user-3a4d80a9c3cca7ffd1bc341f.ede04d00e4b168bed35d9fcde8c2f92f.00d7fecf89201691f94b01e5b294da65.e7ea4c191b2c9a059ce5658deb7349c26a931ed8b7a04bf0"

If the current user is not a member of this organization, only public agents are listed.

curl https://management-api.useproteus.ai/api/orgs/6816330b6f46b5afc080fbf7/agents \
    -H "Authorization: Bearer user-73dd22b0c07a542d080d48a2.9e0ac60c1472a5f2949f8978e82d2582.dfbaf5a25782b0608e173d295e977259.2a52f18cf2ce3d84872ae7fc73c60822ad6fe0ad7dc21f58"

Update Agent

PUT /api/agents/:agentId

This endpoint updates an agent. The current user must be a member of the org with a role of MEMBER or OWNER.

curl https://management-api.useproteus.ai/api/agents/6819aece84df0fc342cea508 \
    -X PUT \
    -H "Authorization: Bearer user-3a4d80a9c3cca7ffd1bc341f.ede04d00e4b168bed35d9fcde8c2f92f.00d7fecf89201691f94b01e5b294da65.e7ea4c191b2c9a059ce5658deb7349c26a931ed8b7a04bf0" \
    -d '{
            "name": "Updated Temp Agent",
            "goal": "You are a temp assistant. Updated.",
            "description": "updated description"
        }'

Delete Agent

DELETE /api/agents/:agentId

This endpoint deletes an agent. The current user must be a member of the org with a role of OWNER.

curl https://management-api.useproteus.ai/api/agents/6819aece84df0fc342cea508 \
    -X DELETE \
    -H "Authorization: Bearer user-3a4d80a9c3cca7ffd1bc341f.ede04d00e4b168bed35d9fcde8c2f92f.00d7fecf89201691f94b01e5b294da65.e7ea4c191b2c9a059ce5658deb7349c26a931ed8b7a04bf0"

Orgs Plugins