PgBeam Docs
Agents

listAgentCredentials

List agent credentials

Lists agent credentials for the project. Secrets are never returned.

Usage

const result = await api.agents.listAgentCredentials({
  pathParams: { project_id: "prj_xxx" },
});

Parameters

ParameterTypeRequiredDescription
pathParams.project_idstringYesUnique project identifier (prefixed, e.g. prj_xxx).
queryParams.page_sizenumberNoMaximum number of items to return (1-100, default 20).
queryParams.page_tokenstringNoOpaque token for cursor-based pagination.

Response

Promise<ListAgentCredentialsResponse> — list of agent credentials.

Example

import { PgBeamClient } from "pgbeam";

const client = new PgBeamClient({
  token: "pbk_...",
  baseUrl: "https://api.pgbeam.com",
});

const result = await client.api.agents.listAgentCredentials({
  pathParams: { project_id: "prj_xxx" },
  queryParams: { page_size: 20, page_token: "..." },
});

Errors

StatusDescription
400Invalid request parameters.
401Missing or invalid authentication.
403Operation not allowed by current plan limits.
404Resource not found.
429Rate limited. Try again later.

On this page