Get agent by external ID

GET

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

GET

/api/v1/agents/external/:externalId

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

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   "agentAttributes": [
9     {
10       "name": "Emails sent signal",
11       "active": true,
12       "pricing": {
13         "taxable": true,
14         "chargeType": "usage",
15         "pricingModel": "PerUnit",
16         "billingFrequency": "monthly",
17         "pricePoints": {
18           "USD": {
19             "unitPrice": 100
20           }
21         },
22         "eventName": "emails_sent"
23       }
24     }
25   ]
26 }

Authentication

AuthorizationBearer

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

Path Parameters

externalIdstringRequired

Response

Success response

idstring

organizationIdstring

namestring

activeboolean

externalIdstring or null

descriptionstring or null

agentCodestring or null

agentAttributeslist of objects or null