createAgentCredential

Issues a scoped Postgres login and hosted MCP token for an AI agent. The connection string and MCP token are returned once and cannot be retrieved again.

Usage

const result = await api.agents.createAgentCredential({
  pathParams: { project_id: "prj_xxx" },
  body: {
    name: "...",
    policy_profile_id: "...",
  },
});

Parameters

Parameter	Type	Required	Description
pathParams.project_id	`string`	Yes	Unique project identifier (prefixed, e.g. prj_xxx).
body.name	`string`	Yes	Human-readable label for the credential.
body.policy_profile_id	`string`	Yes	The policy profile to enforce for this credential.
body.principal_type	`"agent" \| "human"`	No	Whether this credential represents an autonomous agent or a human operator.
body.expires_at	`string`	No	Optional expiry. When set, the credential becomes unusable at this time (must be in the future). Omit or set null for a credential that never expires.

Response

Promise<AgentCredentialSecrets> — agent credential created. secrets shown once.

Example

import { PgBeamClient } from "pgbeam";

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

const result = await client.api.agents.createAgentCredential({
  pathParams: { project_id: "prj_xxx" },
  body: {
    name: "...",
    policy_profile_id: "...",
  },
});

Errors

Status	Description
400	Invalid request parameters.
401	Missing or invalid authentication.
403	Agent credential quota reached for the organization plan.
404	Resource not found.
409	Resource already exists or conflicts with current state.
429	Rate limited. Try again later.