Skip to content
Pile
Esc
↑↓navigate↵open⌘Jpreview

List agent provider catalog

GET/workspaces/{organizationId}/agent/providers/catalog
Path parameters
organizationIdstringrequired
Responses
200Agents a workspace can add, with hosted vs BYO modes and required fields
providersobject[]required
Show properties
Array of object
idstringrequired
namestringrequired
modesobject[]required
Show properties
Array of object
idstringrequired
Allowed:hostedbyo
labelstringrequired
helpstring
fieldsobject[]required
Show properties
Array of object
keystringrequired
labelstringrequired
requiredbooleanrequired
typestringrequired
Allowed:textsecretselect
optionsobject[]
Show properties
Array of object
valuestringrequired
labelstringrequired
helpstring
Try it
Server
Parameters
Request
curl -X GET "/workspaces/string/agent/providers/catalog"
Response
{
  "providers": [
    {
      "id": "string",
      "name": "string",
      "modes": [
        {
          "id": "hosted",
          "label": "string",
          "help": "string",
          "fields": [
            {
              "key": "string",
              "label": "string",
              "required": true,
              "type": "text",
              "options": [
                {
                  "value": "string",
                  "label": "string"
                }
              ],
              "help": "string"
            }
          ]
        }
      ]
    }
  ]
}