Agents

Create an agent and define, model and its parameters.

Retrieve agents authored by the user.

get
Authorizations
Responses
200
A list of agents
application/json
get
GET /api/agents HTTP/1.1
Host: www.openindex.ai
Authorization: Bearer JWT
Accept: */*
200

A list of agents

{
  "ok": true,
  "agents": [
    {
      "id": "text",
      "slug": "text",
      "name": "text",
      "description": "text",
      "image": "text",
      "privacy": "text",
      "namespace": "text",
      "prompt": "text",
      "isAutonomous": true,
      "welcome": "text",
      "model": "gpt-3.5-turbo",
      "params": {
        "temperature": 1,
        "topP": 1,
        "frequencePenalty": 1,
        "presencePenalty": 1
      },
      "tools": [
        {
          "id": "text",
          "checked": true
        }
      ],
      "userId": "text",
      "createdAt": 1,
      "updatedAt": 1,
      "status": "text",
      "collections": [
        "text"
      ]
    }
  ]
}

Create or update an agent

post
Authorizations
Body
idstringOptional
namestringOptional
descriptionstringOptional
imagestringOptional
privacystring · enumOptionalPossible values:
isAutonomousbooleanOptional
promptstringOptional
welcomestringOptional
modelstring · enumOptional

Name of the LLM model to use.

Possible values:
collectionsstring[]Optional
Responses
200
The result of the agent creation or update.
application/json
post
POST /api/agents HTTP/1.1
Host: www.openindex.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 298

{
  "id": "text",
  "name": "text",
  "description": "text",
  "image": "text",
  "privacy": "public",
  "isAutonomous": true,
  "prompt": "text",
  "welcome": "text",
  "model": "gpt-3.5-turbo",
  "params": {
    "temperature": 1,
    "topP": 1,
    "frequencePenalty": 1,
    "presencePenalty": 1
  },
  "tools": [
    {
      "id": "text",
      "checked": true
    }
  ],
  "collections": [
    "text"
  ]
}
{
  "ok": true,
  "agentId": "text"
}

Please see the list of supported models for the model parameter above.

PreviousCollectionsNextChat

Last updated