സാരാംശം
പ്രവേശനം
അഡ്മിൻ API കീ ഉപയോഗിച്ച് മാനേജ്മെന്റ് API വഴി EKM എൻഡ്പോയിന്റുകൾ ആക്സസ് ചെയ്യാം. https://platform.openai.com/settings/organization/admin-keys (സാധാരണ API കീ ഉപയോഗിക്കരുത്). സ്ഥാപന ഉടമകൾക്ക് അഡ്മിൻ API കീകൾ ലഭ്യമാണ്.
ബാഹ്യ കീകൾ സൃഷ്ടിക്കാനോ ഇല്ലാതാക്കാനോ
api.external_keys.writeഉപയോഗിക്കുക. ബാഹ്യ കീകൾ പട്ടികപ്പെടുത്താനോ വീണ്ടെടുക്കാനോ സാധുത പരിശോധിക്കാനോapi.external_keys.readഉപയോഗിക്കുക. വായനയും എഴുത്തും നടത്തേണ്ടതുണ്ടെങ്കിൽ മാത്രമേ ഒരേ കീയ്ക്ക് രണ്ട് അനുമതി പരിധികളും ആവശ്യമുള്ളൂ.
ഉപയോഗം
https://api.openai.com/v1/organization/external_keys എന്ന പുതിയ എൻഡ്പോയിന്റ് വഴി നിങ്ങളുടെ EKM ക്രമീകരണം സ്ഥാപന തലത്തിൽ രജിസ്റ്റർ ചെയ്യുന്നു.
നിങ്ങളുടെ EKM ക്രമീകരണം രജിസ്റ്റർ ചെയ്യുമ്പോൾ extkey_xxxx എന്ന രൂപത്തിലുള്ള ഒരു external_key_id ലഭിക്കും.
പ്രോജക്റ്റ് സൃഷ്ടിക്കാനുള്ള നിലവിലെ എൻഡ്പോയിന്റായ https://api.openai.com/v1/organization/projects എന്നതിലേക്കുള്ള അഭ്യർത്ഥനയുടെ ഉള്ളടക്കത്തിൽ external_key_id ഉൾപ്പെടുത്തിയാണ് EKM ക്രമീകരണങ്ങൾ പ്രോജക്റ്റ് തലത്തിൽ സജീവമാക്കുന്നത്.
നിയന്ത്രണങ്ങൾ
ആദ്യം മാനേജ്മെന്റ് API വഴി ഒരു പുതിയ പ്രോജക്റ്റിൽ EKM പരീക്ഷിക്കണം.
നിങ്ങളുടെ EKM ജോലികൾക്കായി പുതിയ പ്രോജക്റ്റുകൾ സൃഷ്ടിക്കാൻ ഞങ്ങൾ ശുപാർശ ചെയ്യുന്നു. നിലവിൽ പ്രവർത്തിക്കുന്ന പ്രൊഡക്ഷൻ പ്രോജക്റ്റുകളിൽ EKM നടപ്പാക്കുന്നതിനുമുമ്പ് താഴെ പറയുന്ന മികച്ച രീതികൾ ശ്രദ്ധിക്കുക.
പ്രൊഡക്ഷനിൽ ഉപയോഗിക്കുന്ന എല്ലാ API സവിശേഷതകളും ആദ്യം നിങ്ങളുടെ പരീക്ഷണ EKM API പ്രോജക്റ്റിൽ പരിശോധിക്കുക.
എല്ലാ പ്രൊഡക്ഷൻ API പ്രോജക്റ്റുകളിലും ഒരുമിച്ച് EKM നടപ്പാക്കുന്നതിനു പകരം ഘട്ടംഘട്ടമായി നടപ്പാക്കുക.
സ്ഥാപന-തല endpoints
നിങ്ങളുടെ സ്ഥാപനത്തിൽ ഒരു ബാഹ്യ കീ രജിസ്റ്റർ ചെയ്യുക
AWS
അഭ്യർത്ഥനയുടെ മാതൃക:
type: അക്ഷരശ്രേണി - എല്ലായ്പ്പോഴും “aws”
name: അക്ഷരശ്രേണി - നിങ്ങളുടെ ക്രമീകരണം എളുപ്പത്തിൽ തിരിച്ചറിയാനുള്ള പേര്
role_arn: അക്ഷരശ്രേണി - നിങ്ങളുടെ ക്ലൗഡിൽ OpenAI സ്വീകരിക്കുന്ന റോളിന്റെ ARN
kms_arn: അക്ഷരശ്രേണി - നിങ്ങൾ കൈകാര്യം ചെയ്യുന്ന മുഖ്യ കീയുടെ കീ പരിപാലന സംവിധാനത്തിലെ ARN
external_id: അക്ഷരശ്രേണി - നിങ്ങളുടെ സ്ഥാപന ID അല്ലെങ്കിൽ API പ്രോജക്റ്റ് ID
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys" \
-d '{
"type": "aws",
"name": "AWS EKM Config",
"role_arn": "arn:aws:iam::<12_DIGIT_ACCOUNT_NUMBER>:role/<ROLE>",
"kms_arn": "arn:aws:kms:<REGION>:<ACCOUNT_NUMBER>:key/<UUID>",
"external_id": "<your org id or project id>"
}'പ്രതികരണത്തിന്റെ മാതൃക:
{
"id": "extkey_xxxx",
"object": "organization.external_key",
"created_at": 1746175499,
"api_project_ids": [],
"type": "aws",
"name": "AWS EKM Config",
"role_arn": "arn:aws:iam::<ACCOUNT_NUMBER>:role/<ROLE>",
"kms_arn": "arn:aws:kms:<REGION>:<ACCOUNT_NUMBER>:key/<UUID>",
"external_id": "<your org id or project id>"
}GCP
അഭ്യർത്ഥനയുടെ മാതൃക:
type: അക്ഷരശ്രേണി - എല്ലായ്പ്പോഴും “gcp”,
name: അക്ഷരശ്രേണി - നിങ്ങളുടെ ക്രമീകരണം എളുപ്പത്തിൽ തിരിച്ചറിയാനുള്ള പേര്
workload_identity_project_number: അക്ഷരശ്രേണി - OpenAI-യുടെ ജോലിഭാര ഐഡന്റിറ്റി രജിസ്റ്റർ ചെയ്ത GCP പ്രോജക്റ്റിന്റെ അക്കങ്ങളിലുള്ള നമ്പർ
workload_identity_pool_id: അക്ഷരശ്രേണി - OpenAI-യ്ക്കായി നിങ്ങൾ രജിസ്റ്റർ ചെയ്ത ജോലിഭാര ഐഡന്റിറ്റി ദാതാവ് ഉൾപ്പെടുന്ന പൂൾ
workload_identity_provider_id: അക്ഷരശ്രേണി - OpenAI-യ്ക്കായി നിങ്ങൾ രജിസ്റ്റർ ചെയ്ത ജോലിഭാര ഐഡന്റിറ്റി ദാതാവ്
audience: അക്ഷരശ്രേണി - നിങ്ങളുടെ GCP STS വഴി ഞങ്ങൾ ഒരു റോൾ സ്വീകരിക്കുമ്പോൾ OpenAI ടോക്കണിൽ നൽകേണ്ട ലക്ഷ്യ സ്വീകർത്താവ്
kms_project_id: അക്ഷരശ്രേണി - നിങ്ങളുടെ KMS സ്ഥിതിചെയ്യുന്ന GCP പ്രോജക്റ്റിന്റെ പേര്
kms_key_ring_name: അക്ഷരശ്രേണി - നിങ്ങൾ കൈകാര്യം ചെയ്യുന്ന മുഖ്യ കീ ഉൾപ്പെടുന്ന കീ പരിപാലന സംവിധാനത്തിലെ കീ റിംഗ്
kms_key_name: അക്ഷരശ്രേണി - കീ പരിപാലന സംവിധാനത്തിലെ മുഖ്യ കീയുടെ പേര്
kms_key_location: അക്ഷരശ്രേണി - നിങ്ങളുടെ കീ പരിപാലന സംവിധാനത്തിലെ മുഖ്യ കീ സ്ഥിതിചെയ്യുന്ന മേഖല
OpenAI-യുടെ ജോലിഭാര ഐഡന്റിറ്റി രജിസ്റ്റർ ചെയ്ത GCP പ്രോജക്റ്റിൽനിന്ന് വ്യത്യസ്തമായ മറ്റൊരു പ്രോജക്റ്റിലാണ് നിങ്ങളുടെ KMS സ്ഥിതിചെയ്യുന്നതെങ്കിൽ, https://console.developers.google.com/apis/api/cloudkms.googleapis.com/overview സന്ദർശിച്ച് OpenAI-യുടെ ജോലിഭാര ഐഡന്റിറ്റി ഉൾപ്പെടുന്ന പ്രോജക്റ്റിൽ കുറഞ്ഞത് KMS എങ്കിലും പ്രവർത്തനക്ഷമമാണെന്ന് ഉറപ്പാക്കുക.
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys" \
-d '{
"type": "gcp",
"name": "GCP EKM Config",
"workload_identity_project_number": "123456789012",
"workload_identity_pool_id": "openai-azure",
"workload_identity_provider_id": "openai-ekm-service-role",
"audience": "<your org id or project id>",
"kms_project_id": "adjective-noun-12345",
"kms_key_name": "openai-kms-key",
"kms_key_ring_name": "openai-kms-key-ring",
"kms_key_location": "us-east1"
}'പ്രതികരണത്തിന്റെ മാതൃക:
{
"id": "extkey_xxxxxx",
"object": "organization.external_key",
"created_at": 1746174349,
"api_project_ids": [],
"type": "gcp",
"name": "GCP EKM Config",
"workload_identity_project_number": "123456789012",
"kms_key_ring_name": "openai-kms-key-ring",
"kms_key_name": "openai-kms-key",
"kms_key_location": "us-east1",
"audience": "<your org id or project id>",
"kms_project_id": "adjective-noun-12345",
"workload_identity_pool_id": "openai-azure",
"workload_identity_provider_id": "openai-ekm-service-role"
}Azure
അഭ്യർത്ഥനയുടെ മാതൃക:
type: അക്ഷരശ്രേണി - എല്ലായ്പ്പോഴും “azure”,
name: അക്ഷരശ്രേണി - നിങ്ങളുടെ ക്രമീകരണം എളുപ്പത്തിൽ തിരിച്ചറിയാനുള്ള പേര്
tenant_id: അക്ഷരശ്രേണി - നിങ്ങളുടെ Azure ടെനന്റിന്റെ UUID
vault_uri: അക്ഷരശ്രേണി - നിങ്ങൾ കൈകാര്യം ചെയ്യുന്ന മുഖ്യ കീ ഉൾപ്പെടുന്ന Azure വോൾട്ടിന്റെ URI
key_name: അക്ഷരശ്രേണി - നിങ്ങൾ കൈകാര്യം ചെയ്യുന്ന Azure Key Vault മുഖ്യ കീയുടെ പേര്.
അത് <org-xxx>--<any_name> എന്ന രൂപത്തിലായിരിക്കണം
ഇവിടെ org-xxx എന്നത് നിങ്ങളുടെ OpenAI സ്ഥാപന ID ആണ്. ഇത് https://platform.openai.com/settings/organization/general എന്നതിൽ കണ്ടെത്താം
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys" \
-d '{
"type": "azure",
"name": "Azure EKM Config",
"tenant_id": "<UUID>",
"vault_uri": "https://<VAULT_NAME>.vault.azure.net/",
"key_name": "org-xxx--some-key"
}'പ്രതികരണത്തിന്റെ മാതൃക:
{
"id": "extkey_xxxx",
"object": "organization.external_key",
"created_at": 1746174377,
"api_project_ids": [],
"type": "azure",
"name": "Azure EKM Config",
"tenant_id": "<UUID>",
"vault_uri": "https://<VAULT_NAME>.vault.azure.net/",
"key_name": "org-xxx--some-key"
}OCI
പ്രവർത്തനക്ഷമമാക്കിയ ഒരു AES-256 കീ സജ്ജീകരിച്ച് OpenAI-ക്ക് ആക്സസ് നൽകുക. കീയിൽ openai_organization_id എന്ന സ്വതന്ത്രരൂപത്തിലുള്ള ടാഗ് ഉണ്ടായിരിക്കണം. അതിന്റെ മൂല്യം നിങ്ങളുടെ OpenAI സ്ഥാപന ID ആയിരിക്കണം. സജ്ജീകരണ ഘട്ടങ്ങൾക്കായി കാണുക: എന്റർപ്രൈസ് കീ മാനേജ്മെന്റിനായി OCI വോൾട്ട് ക്രമീകരിക്കൽ.
അഭ്യർത്ഥനയുടെ മാതൃക:
type: string - എല്ലായ്പ്പോഴും "oci"
purpose: string - "ekm"; വ്യക്തമാക്കാതിരുന്നാൽ സ്വീകരിക്കുന്ന മൂല്യം
name: string - നിങ്ങളുടെ ക്രമീകരണം എളുപ്പത്തിൽ തിരിച്ചറിയാനുള്ള പേര്
region: string - നിങ്ങളുടെ വോൾട്ടും കീയും ഉള്ള OCI മേഖല
vault_ocid: string - നിങ്ങളുടെ വോൾട്ടിന്റെ പൂർണ്ണ OCID
key_ocid: string - നിങ്ങളുടെ AES-256 കീയുടെ പൂർണ്ണ OCID
EKM-നായി key_version_ocid നൽകരുത്.
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys" \
-d '{
"type": "oci",
"purpose": "ekm",
"name": "OCI EKM Config",
"region": "us-ashburn-1",
"vault_ocid": "<VAULT_OCID>",
"key_ocid": "<AES_KEY_OCID>"
}'പ്രതികരണത്തിന്റെ മാതൃക:
{
"id": "extkey_xxxx",
"object": "organization.external_key",
"created_at": 1746175499,
"api_project_ids": [],
"type": "oci",
"purpose": "ekm",
"name": "OCI EKM Config",
"region": "us-ashburn-1",
"vault_ocid": "<VAULT_OCID>",
"key_ocid": "<AES_KEY_OCID>"
}വിജയിച്ചാൽ API, HTTP 200 നൽകുന്നു. ലഭിക്കുന്ന id സംരക്ഷിക്കുക. പ്രോജക്റ്റ് സൃഷ്ടിക്കുമ്പോൾ അത് external_key_id ആയി ഉപയോഗിക്കുക. നിലവിലുള്ള പട്ടികപ്പെടുത്തൽ, വീണ്ടെടുക്കൽ, സാധുത പരിശോധിക്കൽ, ഇല്ലാതാക്കൽ പ്രവർത്തനങ്ങൾ OCI രജിസ്ട്രേഷനുകൾക്കും ബാധകമാണ്.
PSP വീണ്ടെടുക്കലിനായി, purpose: "psp_decryption" എന്നും കൃത്യമായ key_version_ocid എന്നും നൽകിയിട്ടുള്ള ഒരു പ്രത്യേക RSA-3072 രജിസ്ട്രേഷൻ ഉപയോഗിക്കുക. psp_decryption_key_id-യുടെ മൂല്യമായി അതിന്റെ OpenAI രജിസ്ട്രേഷൻ ID സജ്ജീകരിക്കുക. ആ RSA കീയുടെ മെറ്റാഡാറ്റയും പൊതു കീകളും വായിക്കാനുള്ള അനുമതി മാത്രമേ OpenAI-ക്ക് ആവശ്യമുള്ളൂ. സമ്പൂർണ്ണ സജ്ജീകരണത്തിനായി കാണുക: അസമമിത കീകൾ സജ്ജീകരിക്കുക — OCI വോൾട്ട്.
നിങ്ങളുടെ സ്ഥാപനത്തിൽ രജിസ്റ്റർ ചെയ്ത ഒരു ബാഹ്യ കീ ഇല്ലാതാക്കുക
ശ്രദ്ധിക്കുക: സജീവമായ ഒരു പ്രോജക്റ്റോ വർക്ക്സ്പേസോ രജിസ്ട്രേഷൻ ഉപയോഗിക്കുന്നിടത്തോളം അത് ഇല്ലാതാക്കാനാവില്ല. EKM-ന്റെ കാര്യത്തിൽ, ബന്ധപ്പെട്ട API പ്രോജക്റ്റുകൾ ആദ്യം ആർക്കൈവ് ചെയ്യുക; വർക്ക്സ്പേസുമായി ബന്ധിപ്പിച്ച EKM രജിസ്ട്രേഷൻ ഇല്ലാതാക്കുന്നതിൽനിന്നുള്ള സംരക്ഷണം തുടരും. PSP വീണ്ടെടുക്കലിന്റെ കാര്യത്തിൽ, രജിസ്ട്രേഷൻ ഇല്ലാതാക്കുന്നതിനുമുമ്പ് അതിനെ പരാമർശിക്കുന്ന എല്ലാ സജീവ പ്രോജക്റ്റുകളിലെയും psp_decryption_key_id മാറ്റിസ്ഥാപിക്കുകയോ മായ്ക്കുകയോ ചെയ്യുക. OpenAI രജിസ്ട്രേഷൻ ഇല്ലാതാക്കുന്നത് ക്ലൗഡ് കീ ഇല്ലാതാക്കില്ല.
അഭ്യർത്ഥനയുടെ മാതൃക
curl -X DELETE \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys/extkey_xxxx"പ്രതികരണത്തിന്റെ മാതൃക
{
"id": "extkey_xxxxx",
"object": "organization.external_key.deleted",
"created_at": 1746127808,
"api_project_ids": [],
"type": "aws",
"account_number": "123456789012",
"kms_arn": "arn:aws:kms:<REGION>:<ACCOUNT_NUMBER>:key/<UUID>",
"name": "AWS EKM Config",
"role_arn": "arn:aws:iam::<ACCOUNT_NUMBER>:role/<ROLE>"
}നിങ്ങളുടെ സ്ഥാപനത്തിൽ രജിസ്റ്റർ ചെയ്ത ബാഹ്യ കീകൾ നേടുക
ഉദ്ദേശ്യമനുസരിച്ച് ഫിൽട്ടർ ചെയ്യാതിരുന്നാൽ, പട്ടികയിൽ EKM രജിസ്ട്രേഷനുകളും PSP വീണ്ടെടുക്കൽ രജിസ്ട്രേഷനുകളും ഉൾപ്പെടും. ഉദ്ദേശ്യമനുസരിച്ച് ഫിൽട്ടർ ചെയ്യാൻ ?purpose=ekm അല്ലെങ്കിൽ ?purpose=psp_decryption ഉപയോഗിക്കുക.
അഭ്യർത്ഥനയുടെ മാതൃക
curl -X GET \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys"പ്രതികരണത്തിന്റെ മാതൃക
{
"object": "list",
"data": [
{
"id": "extkey_xxxx",
"object": "organization.external_key",
"created_at": 1746127808,
"api_project_ids": [],
"type": "aws",
"name": "AWS EKM Config",
"account_number": "123456789012",
"kms_arn": "arn:aws:kms:<REGION>:<ACCOUNT_NUMBER>:key/<UUID>",
"role_arn": "arn:aws:iam::<ACCOUNT_NUMBER>:role/<ROLE>"
}
],
"first_id": "extkey_xxxx",
"has_more": false,
"last_id": "extkey_xxxx"
}ഒരു ബാഹ്യ കീയുടെ സാധുത പരിശോധിക്കുക
OpenAI-ക്ക് നിങ്ങളുടെ ക്ലൗഡ് കീ തുടർന്നും ആക്സസ് ചെയ്യാനാകുന്നുണ്ടോ എന്ന് അറിയാൻ സാധുതാ പരിശോധന ഉപയോഗിക്കുക.
EKM-ന്റെ കാര്യത്തിൽ, കീ ഉപയോഗിച്ച് എൻക്രിപ്റ്റ് ചെയ്യാനും ഡീക്രിപ്റ്റ് ചെയ്യാനും കഴിയുന്നുണ്ടോ എന്ന് OpenAI പരിശോധിക്കുന്നു. ആക്സസ് പിൻവലിക്കലും കാഷിങ്ങും എങ്ങനെ പ്രവർത്തിക്കുന്നു എന്നറിയാൻ കാണുക: കീയുടെ ജീവിതചക്രം സംബന്ധിച്ച മാർഗനിർദേശങ്ങൾ.
PSP വീണ്ടെടുക്കലിന്റെ കാര്യത്തിൽ, രജിസ്റ്റർ ചെയ്ത പതിപ്പിന്റെ പൊതു കീ OpenAI ലഭ്യമാക്കി സംഭരിച്ച സ്നാപ്ഷോട്ടുമായി താരതമ്യം ചെയ്യുന്നു. സാധുതാ പരിശോധന വിജയിച്ചതുകൊണ്ട് നിങ്ങളുടെ വീണ്ടെടുക്കൽ ഐഡന്റിറ്റിക്ക് ഡീക്രിപ്റ്റ് ചെയ്യാൻ കഴിയുമെന്ന് ഉറപ്പാകുന്നില്ല. സാധുതാ പരിശോധന പരാജയപ്പെട്ടാലും സംഭരിച്ച പൊതു കീയുടെ സ്നാപ്ഷോട്ട് നീക്കം ചെയ്യുകയോ മാറ്റിസ്ഥാപിക്കുകയോ ചെയ്യില്ല.
GET ഉപയോഗിച്ച് ഒരു രജിസ്ട്രേഷൻ വീണ്ടെടുക്കുമ്പോൾ സംഭരിച്ച ക്രമീകരണമാണ് ലഭിക്കുന്നത്; നിങ്ങളുടെ ക്ലൗഡ് കീയിലേക്കുള്ള ആക്സസ് വീണ്ടും പരിശോധിക്കില്ല.
അഭ്യർത്ഥനയുടെ മാതൃക
curl -X POST -H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys/extkey_xxx/validate"പ്രതികരണത്തിന്റെ മാതൃക
{
"status": "success"
}അല്ലെങ്കിൽ, ക്ലൗഡ് പ്രൊവൈഡറിൽ നിന്ന് ഒരു പിശക് വന്നിരിക്കുന്നു.
പ്രോജക്റ്റ്-തല endpoints
ബാഹ്യ കീ ID ഉപയോഗിച്ച് പുതിയ പ്രോജക്റ്റ് സൃഷ്ടിക്കുക
അഭ്യർത്ഥനയിലും പ്രതികരണത്തിലും external_key_id പരാമീറ്റർ കൂടി ഉൾപ്പെടുത്തിയിട്ടുണ്ടെന്നതൊഴിച്ചാൽ, ഇത് പ്രോജക്റ്റ് സൃഷ്ടിക്കാനുള്ള നിലവിലെ എൻഡ്പോയിന്റിന് സമാനമാണ്.
അഭ്യർത്ഥനയുടെ മാതൃക
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/projects" \
-d '{
"name": "Some Project",
"external_key_id": "extkey_xxxx"
}'പ്രതികരണത്തിന്റെ മാതൃക
{
"object": "organization.project",
"id": "proj_xxxxx",
"name": "Some Project",
"external_key_id": "extkey_xxxx",
"created_at": 1740012721,
"archived_at": null,
"status": "active"
}നിലവിലുള്ള ഒരു പ്രോജക്റ്റിൽ ബാഹ്യ കീ ID ചേർത്ത് പുതുക്കുക
പ്രോജക്റ്റ് പുതുക്കാനുള്ള നിലവിലെ എൻഡ്പോയിന്റ് തന്നെയാണിത്; അഭ്യർത്ഥനയിലും പ്രതികരണത്തിലും external_key_id പരാമീറ്റർ കൂടി ചേർത്തിട്ടുണ്ട് എന്നതാണ് വ്യത്യാസം.
നിങ്ങളുടെ EKM ജോലികൾക്കായി പുതിയ API പ്രോജക്റ്റുകൾ സൃഷ്ടിക്കാൻ ഞങ്ങൾ ശുപാർശ ചെയ്യുന്നു. നിലവിൽ പ്രവർത്തിക്കുന്ന പ്രൊഡക്ഷൻ പ്രോജക്റ്റുകളിൽ EKM നടപ്പാക്കുന്നതിനുമുമ്പ് താഴെ പറയുന്ന മികച്ച രീതികൾ ശ്രദ്ധിക്കുക.
പ്രൊഡക്ഷനിൽ ഉപയോഗിക്കുന്ന എല്ലാ API സവിശേഷതകളും ആദ്യം നിങ്ങളുടെ പരീക്ഷണ EKM API പ്രോജക്റ്റിൽ പരിശോധിക്കുക.
എല്ലാ പ്രൊഡക്ഷൻ API പ്രോജക്റ്റുകളിലും ഒരുമിച്ച് EKM നടപ്പാക്കുന്നതിനു പകരം ഘട്ടംഘട്ടമായി നടപ്പാക്കുക.
അഭ്യർത്ഥനയുടെ മാതൃക
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/projects/proj_xxx" \
-d '{
"external_key_id": "extkey_xxxx"
}'നിങ്ങളുടെ സ്ഥാപനത്തിലെ എല്ലാ പ്രോജക്റ്റുകളും പട്ടികപ്പെടുത്തുക
API പ്രതികരണത്തിൽ external_key_id കൂടി ഉൾപ്പെടുത്തിയിട്ടുണ്ടെന്നതൊഴിച്ചാൽ, ഇത് നിലവിലുള്ള എൻഡ്പോയിന്റിന് സമാനമാണ്.
അഭ്യർത്ഥനയുടെ മാതൃക
curl -X GET \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/projects"പ്രതികരണത്തിന്റെ മാതൃക
{
"object": "list",
"data": [
{
"object": "organization.project",
"id": "proj_xxxx",
"name": "Project Name",
"external_key_id": "extkey_xxxx",
"created_at": 1717798982,
"archived_at": null,
"status": "active"
}
],
"first_id": "proj_xxxx",
"last_id": "proj_xxxx",
"has_more": true
}