Save a credential profile

PUT

credential-profiles

{id}

curl --request PUT \
  --url "https://api.bead.run/credential-profiles/$PROFILE_ID" \
  --header "X-API-Key: $BEAD_API_KEY" \
  --header "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "name": "build-agent",
  "material": {
    "env": {
      "OPENAI_API_KEY": "YOUR_OPENAI_API_KEY"
    }
  }
}
JSON

from beadrun import Bead

client = Bead()
result = client.profiles.put("fe1593e7-c31e-4cdd-96df-80ef26fa1275", "build-agent", {"env": {"OPENAI_API_KEY": "YOUR_OPENAI_API_KEY"}})
client.close()

import { Bead } from "@beadrun/sdk";

const client = new Bead();
const result = await client.profiles.put("fe1593e7-c31e-4cdd-96df-80ef26fa1275", "build-agent", {"env": {"OPENAI_API_KEY": "YOUR_OPENAI_API_KEY"}});

{
  "id": "<string>",
  "name": "<string>",
  "version": 123,
  "revoked": true
}

Authentication

Send your scoped bearer token in the Authorization: Bearer <BEAD_TOKEN> header, or send your API key in X-API-Key.

Parameters

string

required

UUID of the credential profile. Format: uuid.

Request body

The JSON body is required.

string

required

Profile display name; 1–100 bytes, cannot start with env: or contain secret values. Minimum length: 1. Maximum length: 100.

object

required

Encrypted credential material; use a credential pool or legacy env/codexAuth, not both.

Show Properties

object

Nonempty agent API keys under OPENAI_API_KEY, CODEX_API_KEY, ANTHROPIC_API_KEY, or CLAUDE_CODE_OAUTH_TOKEN. Additional keys accept string values.

object[]

Ordered credential pool, at most 64 entries; cannot be combined with env or codexAuth.

Show Properties

string

required

Credential format. Allowed values: "apiKey", "claudeOauth", "codexAuth".

string

API key provider; custom providers require models and a baseUrl.

string[]

Models routed to this API key; at most 128 names.

string

API key secret for an apiKey entry.

string

Optional HTTPS API origin; cannot include credentials, query, or fragment.

string

OAuth access token for a claudeOauth entry.

string

Optional OAuth refresh token.

integer

OAuth expiration as Unix seconds.

string

Codex authentication JSON with tokens.access_token and tokens.account_id for a codexAuth entry.

string

A JSON object encoded as a string, in the Codex authentication format.

curl --request PUT \
  --url "https://api.bead.run/credential-profiles/$PROFILE_ID" \
  --header "X-API-Key: $BEAD_API_KEY" \
  --header "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "name": "build-agent",
  "material": {
    "env": {
      "OPENAI_API_KEY": "YOUR_OPENAI_API_KEY"
    }
  }
}
JSON

from beadrun import Bead

client = Bead()
result = client.profiles.put("fe1593e7-c31e-4cdd-96df-80ef26fa1275", "build-agent", {"env": {"OPENAI_API_KEY": "YOUR_OPENAI_API_KEY"}})
client.close()

import { Bead } from "@beadrun/sdk";

const client = new Bead();
const result = await client.profiles.put("fe1593e7-c31e-4cdd-96df-80ef26fa1275", "build-agent", {"env": {"OPENAI_API_KEY": "YOUR_OPENAI_API_KEY"}});

Response

200

Profile saved with an incremented version.

string

required

Profile UUID.

string

required

Display name for the profile.

integer

required

Version incremented when credentials are replaced or revoked.

boolean

required

Whether delivery of this profile has been revoked.

Errors

Status	Meaning
400	Invalid resource UUID or request parameters.
401	Authentication credential is missing or rejected.
403	The credential lacks the required scope.
404	The requested resource does not exist or is outside your organization.
409	The profile is managed by another credential flow or its state conflicts with this write.
413	Request body exceeds the route limit.
429	Request or resource admission limit exceeded (`admission_limit`; trial capacity can return `free_capacity_full`). Follow limit.next_action and Retry-After when present.
500	Credential profile metadata could not be serialized.
503	Service or persistence is temporarily unavailable.

curl --request PUT \
  --url "https://api.bead.run/credential-profiles/$PROFILE_ID" \
  --header "X-API-Key: $BEAD_API_KEY" \
  --header "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "name": "build-agent",
  "material": {
    "env": {
      "OPENAI_API_KEY": "YOUR_OPENAI_API_KEY"
    }
  }
}
JSON

from beadrun import Bead

client = Bead()
result = client.profiles.put("fe1593e7-c31e-4cdd-96df-80ef26fa1275", "build-agent", {"env": {"OPENAI_API_KEY": "YOUR_OPENAI_API_KEY"}})
client.close()

import { Bead } from "@beadrun/sdk";

const client = new Bead();
const result = await client.profiles.put("fe1593e7-c31e-4cdd-96df-80ef26fa1275", "build-agent", {"env": {"OPENAI_API_KEY": "YOUR_OPENAI_API_KEY"}});

{
  "id": "<string>",
  "name": "<string>",
  "version": 123,
  "revoked": true
}

Start here

Endpoints

Save a credential profile

Authentication

Parameters

Request body

Response

200

Errors

​Authentication

​Parameters

​Request body

​Response

​200

​Errors

Authentication

Parameters

Request body

Response

200

Errors