List agents

curl --request GET \
  --url https://service.abundly.ai/workspaceapi/agents \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://service.abundly.ai/workspaceapi/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://service.abundly.ai/workspaceapi/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://service.abundly.ai/workspaceapi/agents"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://service.abundly.ai/workspaceapi/agents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "agents": [
    {
      "id": "<string>",
      "name": "<string>",
      "adminOnly": true,
      "enabled": true,
      "capabilities": [
        "<string>"
      ],
      "isPrivate": true,
      "description": "<string>",
      "imageUrl": "<string>",
      "groupId": "<string>",
      "adminRestriction": "<string>",
      "agentDiscoverability": "<string>",
      "phase": "<string>",
      "effectivePhase": "<string>",
      "tags": [
        "<string>"
      ],
      "keyMetrics": [
        {
          "name": "<string>"
        }
      ],
      "valueStatement": "<string>",
      "criticality": "<string>",
      "dailyCreditLimit": 123,
      "monthlyCreditLimit": 123,
      "updatedAt": "<string>"
    }
  ],
  "overview": {
    "reducedAgents": [
      {
        "id": "<string>",
        "isPrivate": true
      }
    ],
    "lastUsageByAgent": {}
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

API Reference

List agents

Every agent in the workspace, restricted and personal ones included (marked with isPrivate). capabilities is a mixed array of plain strings and { name, settings } objects, so normalise to the name before counting. With includeOverview=true the response also carries overview.reducedAgents — one entry per agent with its access, capabilities, integrations, exposure flags and hasInstructions (not the instruction text) — plus overview.lastUsageByAgent. That single call is the reliable way to cover the whole estate, since per-agent endpoints reject restricted and personal agents.

GET

workspaceapi

agents

List agents

curl --request GET \
  --url https://service.abundly.ai/workspaceapi/agents \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://service.abundly.ai/workspaceapi/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://service.abundly.ai/workspaceapi/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://service.abundly.ai/workspaceapi/agents"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://service.abundly.ai/workspaceapi/agents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "agents": [
    {
      "id": "<string>",
      "name": "<string>",
      "adminOnly": true,
      "enabled": true,
      "capabilities": [
        "<string>"
      ],
      "isPrivate": true,
      "description": "<string>",
      "imageUrl": "<string>",
      "groupId": "<string>",
      "adminRestriction": "<string>",
      "agentDiscoverability": "<string>",
      "phase": "<string>",
      "effectivePhase": "<string>",
      "tags": [
        "<string>"
      ],
      "keyMetrics": [
        {
          "name": "<string>"
        }
      ],
      "valueStatement": "<string>",
      "criticality": "<string>",
      "dailyCreditLimit": 123,
      "monthlyCreditLimit": 123,
      "updatedAt": "<string>"
    }
  ],
  "overview": {
    "reducedAgents": [
      {
        "id": "<string>",
        "isPrivate": true
      }
    ],
    "lastUsageByAgent": {}
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

Workspace API key (wk_). GET endpoints require the Workspace read API scope, POST, PUT, PATCH and DELETE endpoints the Workspace write API scope, and sending or revoking invitations (POST and DELETE /workspaceapi/invites) the Invite members scope. A key stops working when it expires or is disabled.

Query Parameters

includeOverview

boolean

When true, also returns the management overview (per-agent reduced configs + last-usage timestamps). Defaults to false.

Response

Success. Empty result sets are also 200.

agents

object[]

required

Show child attributes

overview

object

Only present when includeOverview=true.

Show child attributes