AI Credentials

AI credentials give your workspaces access to LLM providers — OpenAI, Anthropic, Google, or any OpenAI-compatible endpoint. Agents like Stagehand and browser-use use these credentials to reason about pages and execute instructions.

Access via bctrl.aiCredentials.

list()

List all AI credentials in your organization.

1
const credentials = await bctrl.aiCredentials.list();

Returns AiCredential[]

create(request)

Create a new AI credential.

1
await bctrl.aiCredentials.create({
2
  id: "openai-prod",
3
  provider: "openai",
4
  label: "Production OpenAI",
5
  apiKey: "sk-...",
6
  defaultModel: "gpt-4o",
7
});

Returns AiCredential

get(id)

Get a specific credential by ID.

1
const cred = await bctrl.aiCredentials.get("openai-prod");

Returns AiCredential

update(id, request)

Update an existing credential.

1
await bctrl.aiCredentials.update("openai-prod", {
2
  defaultModel: "gpt-4o-mini",
3
  enabled: true,
4
});

Returns AiCredential

delete(id)

Delete a credential.

1
await bctrl.aiCredentials.delete("openai-prod");

test(id)

Test that a credential can connect to its provider.

1
const result = await bctrl.aiCredentials.test("openai-prod");

Returns AiCredentialTestResponse

Usage with workspaces

Credentials are mounted to workspaces via the ai mount. See Scopes & Inheritance for details.

1
const workspace = await bctrl.workspaces.create({
2
  name: "my-agent",
3
  mounts: {
4
    ai: {
5
      allow: ["openai-prod"],
6
      defaults: { openai: "openai-prod" },
7
    },
8
  },
9
});