Get agent by external ID | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.agents.getByExternalId("externalId");
}
main();

{
  "id": "63fd642c-569d-44f9-8d67-5cf4944a16cc",
  "organizationId": "63fd642c-569d-44f9-8d67-5cf4944a16cc",
  "name": "Acme Agent",
  "active": true,
  "externalId": "acme-agent",
  "description": "Acme Agent is an AI agent that does things.",
  "agentAttributes": [
    {
      "name": "Emails sent signal",
      "active": true,
      "pricing": {
        "taxable": true,
        "chargeType": "usage",
        "pricingModel": "PerUnit",
        "billingFrequency": "monthly",
        "pricePoints": {
          "USD": {
            "unitPrice": 100
          }
        },
        "eventName": "emails_sent"
      }
    }
  ]
}

DEPRECATED: Use GET /products/external/{externalId} instead.

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

descriptionstring

agentCodestring

agentAttributeslist of objects