List agents

Deprecated

GET

https://api.agentpaid.io/api/v1/agents

GET

/api/v1/agents

1 import { PaidClient } from "@paid-ai/paid-node";
2 
3 async function main() {
4     const client = new PaidClient({
5         environment: "https://api.agentpaid.io/api/v1",
6         token: "YOUR_TOKEN_HERE",
7     });
8     await client.agents.list();
9 }
10 main();

Try it

200Retrieved

1 [
2   {
3     "id": "agent_9f8b7c6d5e4a3b2c1d0e",
4     "organizationId": "org_1234567890abcdef",
5     "name": "Premium Support Agent",
6     "active": true,
7     "externalId": "EXT-AGT-2024-001",
8     "description": "Handles premium customer support with 24/7 availability.",
9     "agentCode": "PSA-001",
10     "agentAttributes": [
11       {
12         "name": "Standard Support Package",
13         "active": true,
14         "pricing": {
15           "taxable": true,
16           "chargeType": "recurring",
17           "pricingModel": "PerUnit",
18           "billingFrequency": "monthly",
19           "pricePoints": {
20             "default": {
21               "unitPrice": 15,
22               "minQuantity": 1,
23               "includedQuantity": 0,
24               "tiers": [
25                 {
26                   "unitPrice": 15,
27                   "minQuantity": 1,
28                   "maxQuantity": 10
29                 },
30                 {
31                   "unitPrice": 13.5,
32                   "minQuantity": 11,
33                   "maxQuantity": 50
34                 }
35               ]
36             }
37           },
38           "eventName": "Support Activation",
39           "creditCost": 15
40         }
41       }
42     ]
43   }
44 ]

DEPRECATED: Use /products instead. Agents are now products with type=‘agent’.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Success response

idstring

organizationIdstring

namestring

activeboolean

externalIdstring or null

descriptionstring or null

agentCodestring or null

agentAttributeslist of objects or null