Ambil Kunci API (Admin API)

beta.organization.api_keys.retrieve(api_key_id) -> BetaAPIKey

GET/v1/organizations/api_keys/{api_key_id}

Ambil informasi tentang satu kunci API di organisasi Anda, dicari berdasarkan ID-nya. Endpoint Admin API ini memerlukan kunci Admin API, ditujukan untuk pengelolaan kunci secara terprogram, dan tidak pernah mengembalikan nilai rahasia kunci. Untuk melihat atau membuat kunci API Anda sendiri, buka Kunci API di Claude Console.

Parameters

api_key_id: String⁠Path

ID of the API key.

Returns

class BetaAPIKey { type: :api_key, id, created_at, 8 more }

Ambil Kunci API (Admin API)

require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

beta_api_key = anthropic.beta.organization.api_keys.retrieve("api_key_id")

puts(beta_api_key)

Response 200

{
  "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "created_by": {
    "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
    "type": "user"
  },
  "expires_at": "2024-10-30T23:58:27.427722Z",
  "name": "Developer Key",
  "partial_key_hint": "sk-ant-api03-R2D...igAA",
  "principal": {
    "type": "user_actor",
    "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
  },
  "scope": {
    "type": "workspace",
    "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
  },
  "status": "active",
  "type": "api_key",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}

Returns Examples

Response 200

{
  "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "created_by": {
    "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
    "type": "user"
  },
  "expires_at": "2024-10-30T23:58:27.427722Z",
  "name": "Developer Key",
  "partial_key_hint": "sk-ant-api03-R2D...igAA",
  "principal": {
    "type": "user_actor",
    "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
  },
  "scope": {
    "type": "workspace",
    "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
  },
  "status": "active",
  "type": "api_key",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}