Get agent by ID

GET

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

GET

/api/v1/agents/:agentId

1 import { PaidClient } from "@paid-ai/paid-node";
2 
3 const client = new PaidClient({ token: "YOUR_TOKEN" });
4 await client.agents.get("agentId");

Try it

200Retrieved

1 {
2   "id": "63fd642c-569d-44f9-8d67-5cf4944a16cc",
3   "organizationId": "63fd642c-569d-44f9-8d67-5cf4944a16cc",
4   "name": "Acme Agent",
5   "active": true,
6   "externalId": "acme-agent",
7   "description": "Acme Agent is an AI agent that does things.",
8   "agentCode": "agentCode",
9   "agentAttributes": [
10     {
11       "name": "Emails sent signal",
12       "active": true,
13       "pricing": {
14         "taxable": true,
15         "chargeType": "usage",
16         "pricingModel": "PerUnit",
17         "billingFrequency": "monthly",
18         "pricePoints": {
19           "USD": {
20             "unitPrice": 100
21           }
22         },
23         "eventName": "emails_sent"
24       }
25     }
26   ]
27 }

Authentication

AuthorizationBearer

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

Path parameters

agentIdstringRequired

Response

Success response

idstring

organizationIdstring

namestring

activeboolean

externalIdstring or null

descriptionstring or null

agentCodestring or null

agentAttributeslist of objects or null