COcouchbase
Model Services API Keys (AI Data Plane)

Get API Key

Changed on

Returns an API Key for the given region in the organization by its ID.

In order to access this endpoint, the provided API key must have at least one of the following roles:

  • Organization Owner

To learn more, see Organization, Project, and Database Access Overview.

get/v4/organizations/{organizationId}/aiServices/models/apiKeys/{apiKeyId}

Request

Response

Successfully retrieved the API Key.

keyIdstring

Unique identifier for the Language Model API key

namestring

Name of the Language Model API key

descriptionstring

Description of the Language Model API Key

expirynumber float

Expiry of the API key in number of days. Maximum value is 365 days.

allowedCIDRsstring[]

List of IP addresses or CIDR blocks that are allowed to use this API key.

regionstring

The region where the API key will be created. The apikey created in a region can access all the models available in that region.

Example response

{
  "keyId": "60a95d98-8660-488c-a1e0-25b90e926a1e",
  "name": "MyLanguageModelAPIKey",
  "description": "API key for accessing GPT-4 models",
  "expiry": 180,
  "allowedCIDRs": [
    "192.168.1.0/24",
    "10.0.0.0/8"
  ],
  "allowedModels": [
    {
      "id": "5ca127fe-49da-4a6a-aef9-08393b97643f",
      "name": "GPT-4"
    },
    {
      "id": "6db238gf-50eb-5b7b-bfg0-09404c08754g",
      "name": "Claude 3"
    }
  ],
  "region": "us-east-1",
  "audit": {
    "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
    "createdAt": "2021-09-01T12:34:56Z",
    "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
    "modifiedAt": "2021-09-01T12:34:56Z",
    "version": 1
  }
}

Changes

  • e67df5d1f74eRevision changes
    • info

      api tag Model Services API Keys (AI Data Plane) added

    • info

      api tag Model Services API Keys (AI Services) removed