ਸਾਰ
ਪਹੁੰਚ
ਈਕੇਐੱਮ ਐਂਡਪੌਇੰਟਾਂ ਤੱਕ ਪ੍ਰਬੰਧਨ ਏਪੀਆਈ ਵਿੱਚ ਪ੍ਰਸ਼ਾਸਕ ਏਪੀਆਈ ਕੁੰਜੀ ਰਾਹੀਂ ਪਹੁੰਚ ਕੀਤੀ ਜਾ ਸਕਦੀ ਹੈ. https://platform.openai.com/settings/organization/admin-keys (ਆਮ ਏਪੀਆਈ ਕੁੰਜੀ ਨਾ ਵਰਤੋ). ਪ੍ਰਸ਼ਾਸਕ ਏਪੀਆਈ ਕੁੰਜੀਆਂ ਸੰਸਥਾ ਦੇ ਮਾਲਕਾਂ ਲਈ ਉਪਲਬਧ ਹਨ.
ਬਾਹਰੀ ਕੁੰਜੀਆਂ ਬਣਾਉਣ ਜਾਂ ਮਿਟਾਉਣ ਲਈ
api.external_keys.writeਵਰਤੋ, ਅਤੇ ਬਾਹਰੀ ਕੁੰਜੀਆਂ ਦੀ ਸੂਚੀ ਪ੍ਰਾਪਤ ਕਰਨ ਜਾਂ ਉਨ੍ਹਾਂ ਦੀ ਵੈਧਤਾ ਜਾਂਚਣ ਲਈapi.external_keys.readਵਰਤੋ. ਇੱਕ ਕੁੰਜੀ ਨੂੰ ਦੋਵੇਂ ਅਧਿਕਾਰ-ਦਾਇਰਿਆਂ ਦੀ ਲੋੜ ਸਿਰਫ਼ ਤਾਂ ਹੁੰਦੀ ਹੈ ਜੇ ਉਸ ਨੇ ਪੜ੍ਹਨ ਅਤੇ ਲਿਖਣ, ਦੋਵਾਂ ਤਰ੍ਹਾਂ ਦੀਆਂ ਕਾਰਵਾਈਆਂ ਕਰਨੀਆਂ ਹੋਣ.ਫ਼ਿਲਹਾਲ ਇਨ੍ਹਾਂ ਐਂਡਪੌਇੰਟਾਂ ਤੱਕ ਪਹੁੰਚ ਦੇਣ ਲਈ ਸਾਨੂੰ ਤੁਹਾਡੀ ਸੰਸਥਾ ਵਾਸਤੇ ਵਿਸ਼ੇਸ਼ਤਾ ਫਲੈਗ ਚਾਲੂ ਕਰਨਾ ਪੈਂਦਾ ਹੈ. ਜੇ ਮੌਜੂਦਾ ਪ੍ਰੋਜੈਕਟ ਸੂਚੀ ਐਂਡਪੌਇੰਟ ਦੇ ਜਵਾਬ ਵਿੱਚ external_key_id ਦਿਖਾਈ ਦਿੰਦਾ ਹੈ, ਤਾਂ ਤੁਹਾਡਾ ਵਿਸ਼ੇਸ਼ਤਾ ਫਲੈਗ ਚਾਲੂ ਹੈ: https://api.openai.com/v1/organization/projects.
ਵਰਤੋਂ
ਤੁਹਾਡੀ ਈਕੇਐੱਮ ਸੰਰਚਨਾ ਨਵੇਂ ਐਂਡਪੌਇੰਟ https://api.openai.com/v1/organization/external_keys ਰਾਹੀਂ ਸੰਸਥਾ ਪੱਧਰ 'ਤੇ ਰਜਿਸਟਰ ਕੀਤੀ ਜਾਂਦੀ ਹੈ.
ਆਪਣੀ ਈਕੇਐੱਮ ਸੰਰਚਨਾ ਰਜਿਸਟਰ ਕਰਨ 'ਤੇ ਤੁਹਾਨੂੰ extkey_xxxx ਦੇ ਰੂਪ ਵਿੱਚ external_key_id ਮਿਲਦਾ ਹੈ.
ਈਕੇਐੱਮ ਸੰਰਚਨਾਵਾਂ ਨੂੰ ਪ੍ਰੋਜੈਕਟ ਪੱਧਰ 'ਤੇ ਸਰਗਰਮ ਕਰਨ ਲਈ ਮੌਜੂਦਾ ਪ੍ਰੋਜੈਕਟ ਬਣਾਉਣ ਵਾਲੇ ਐਂਡਪੌਇੰਟ https://api.openai.com/v1/organization/projects ਦੀ ਬੇਨਤੀ ਦੇ ਮੁੱਖ ਭਾਗ ਵਿੱਚ external_key_id ਭੇਜਿਆ ਜਾਂਦਾ ਹੈ.
ਪਾਬੰਦੀਆਂ
ਤੁਹਾਨੂੰ ਪਹਿਲਾਂ ਪ੍ਰਬੰਧਨ ਏਪੀਆਈ ਰਾਹੀਂ ਇੱਕ ਨਵੇਂ ਪ੍ਰੋਜੈਕਟ 'ਤੇ ਈਕੇਐੱਮ ਦੀ ਪਰਖ ਕਰਨੀ ਲਾਜ਼ਮੀ ਹੈ.
ਅਸੀਂ ਤੁਹਾਡੇ ਈਕੇਐੱਮ ਕਾਰਜਾਂ ਲਈ ਨਵੇਂ ਪ੍ਰੋਜੈਕਟ ਬਣਾਉਣ ਦੀ ਸਿਫ਼ਾਰਸ਼ ਕਰਦੇ ਹਾਂ. ਹਾਲਾਂਕਿ, ਜੇ ਤੁਸੀਂ ਕਿਸੇ ਮੌਜੂਦਾ ਪ੍ਰੋਜੈਕਟ 'ਤੇ ਈਕੇਐੱਮ ਚਾਹੁੰਦੇ ਹੋ, ਤਾਂ ਅਸੀਂ ਤੁਹਾਡੇ ਲਈ ਵਿਸ਼ੇਸ਼ਤਾ ਫਲੈਗ ਚਾਲੂ ਕਰ ਸਕਦੇ ਹਾਂ. ਆਪਣੇ ਮੌਜੂਦਾ ਅਸਲ ਵਰਤੋਂ ਵਾਲੇ ਪ੍ਰੋਜੈਕਟਾਂ ਵਿੱਚ ਈਕੇਐੱਮ ਲਾਗੂ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ ਕਿਰਪਾ ਕਰਕੇ ਹੇਠਾਂ ਦਿੱਤੇ ਵਧੀਆ ਅਭਿਆਸਾਂ ਦਾ ਧਿਆਨ ਰੱਖੋ.
ਏਪੀਆਈ ਦੀਆਂ ਉਹ ਸਾਰੀਆਂ ਵਿਸ਼ੇਸ਼ਤਾਵਾਂ ਜੋ ਤੁਸੀਂ ਅਸਲ ਵਰਤੋਂ ਵਿੱਚ ਲਿਆਉਂਦੇ ਹੋ, ਪਹਿਲਾਂ ਆਪਣੇ ਪਰਖ ਵਾਲੇ ਈਕੇਐੱਮ ਏਪੀਆਈ ਪ੍ਰੋਜੈਕਟ ਵਿੱਚ ਜਾਂਚੋ.
ਸਾਰੇ ਅਸਲ ਵਰਤੋਂ ਵਾਲੇ ਏਪੀਆਈ ਪ੍ਰੋਜੈਕਟਾਂ ਵਿੱਚ ਇੱਕੋ ਵਾਰ ਈਕੇਐੱਮ ਲਾਗੂ ਕਰਨ ਦੀ ਬਜਾਏ ਇਸ ਨੂੰ ਪੜਾਅਵਾਰ ਲਾਗੂ ਕਰੋ.
ਸੰਗਠਨ-ਪੱਧਰ ਦੇ endpoints
ਆਪਣੇ ਸੰਗਠਨ 'ਤੇ ਬਾਹਰੀ key ਰਜਿਸਟਰ ਕਰੋ
ਏਡਬਲਿਊਐੱਸ
ਬੇਨਤੀ ਦਾ ਨਮੂਨਾ:
type: ਸਟ੍ਰਿੰਗ - ਹਮੇਸ਼ਾ “aws”
name: ਸਟ੍ਰਿੰਗ - ਤੁਹਾਡੀ ਸੰਰਚਨਾ ਲਈ ਆਸਾਨੀ ਨਾਲ ਪਛਾਣਿਆ ਜਾ ਸਕਣ ਵਾਲਾ ਨਾਮ
role_arn: ਸਟ੍ਰਿੰਗ - ਉਸ ਭੂਮਿਕਾ ਦਾ ਏਆਰਐੱਨ ਜਿਸ ਨੂੰ OpenAI ਤੁਹਾਡੇ ਕਲਾਊਡ ਵਿੱਚ ਅਪਣਾਏਗਾ
kms_arn: ਸਟ੍ਰਿੰਗ - ਤੁਹਾਡੇ ਵੱਲੋਂ ਪ੍ਰਬੰਧਿਤ ਮੁੱਖ ਕੁੰਜੀ ਲਈ ਕੁੰਜੀ ਪ੍ਰਬੰਧਨ ਸਿਸਟਮ ਦਾ ਏਆਰਐੱਨ
external_id: ਸਟ੍ਰਿੰਗ - ਤੁਹਾਡੀ ਸੰਸਥਾ 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>"
}ਜੀਸੀਪੀ
ਬੇਨਤੀ ਦਾ ਨਮੂਨਾ:
type: ਸਟ੍ਰਿੰਗ - ਹਮੇਸ਼ਾ “gcp”,
name: ਸਟ੍ਰਿੰਗ - ਤੁਹਾਡੀ ਸੰਰਚਨਾ ਲਈ ਆਸਾਨੀ ਨਾਲ ਪਛਾਣਿਆ ਜਾ ਸਕਣ ਵਾਲਾ ਨਾਮ
workload_identity_project_number: ਸਟ੍ਰਿੰਗ - ਉਸ ਜੀਸੀਪੀ ਪ੍ਰੋਜੈਕਟ ਦਾ ਅੰਕੀ ਨੰਬਰ ਜਿੱਥੇ ਤੁਸੀਂ OpenAI ਦੀ ਵਰਕਲੋਡ ਪਛਾਣ ਰਜਿਸਟਰ ਕੀਤੀ ਹੈ
workload_identity_pool_id: ਸਟ੍ਰਿੰਗ - ਉਹ ਪੂਲ ਜਿਸ ਵਿੱਚ ਤੁਹਾਡੇ ਵੱਲੋਂ OpenAI ਲਈ ਰਜਿਸਟਰ ਕੀਤਾ ਵਰਕਲੋਡ ਪਛਾਣ ਪ੍ਰਦਾਤਾ ਸ਼ਾਮਲ ਹੈ
workload_identity_provider_id: ਸਟ੍ਰਿੰਗ - ਉਹ ਵਰਕਲੋਡ ਪਛਾਣ ਪ੍ਰਦਾਤਾ ਜੋ ਤੁਸੀਂ OpenAI ਲਈ ਰਜਿਸਟਰ ਕੀਤਾ ਹੈ
audience: ਸਟ੍ਰਿੰਗ - ਉਹ ਨਿਰਧਾਰਿਤ ਪ੍ਰਾਪਤਕਰਤਾ ਜੋ OpenAI ਨੂੰ ਤੁਹਾਡੇ ਜੀਸੀਪੀ ਐੱਸਟੀਐੱਸ ਰਾਹੀਂ ਭੂਮਿਕਾ ਅਪਣਾਉਣ ਵੇਲੇ ਟੋਕਨ ਵਿੱਚ ਭੇਜਣਾ ਚਾਹੀਦਾ ਹੈ
kms_project_id: ਸਟ੍ਰਿੰਗ - ਉਸ ਜੀਸੀਪੀ ਪ੍ਰੋਜੈਕਟ ਦਾ ਨਾਮ ਜਿੱਥੇ ਤੁਹਾਡਾ ਕੇਐੱਮਐੱਸ ਮੌਜੂਦ ਹੈ
kms_key_ring_name: ਸਟ੍ਰਿੰਗ - ਕੁੰਜੀ ਪ੍ਰਬੰਧਨ ਸਿਸਟਮ ਦਾ ਉਹ ਕੁੰਜੀ-ਸਮੂਹ ਜਿਸ ਵਿੱਚ ਤੁਹਾਡੇ ਵੱਲੋਂ ਪ੍ਰਬੰਧਿਤ ਮੁੱਖ ਕੁੰਜੀ ਮੌਜੂਦ ਹੈ
kms_key_name: ਸਟ੍ਰਿੰਗ - ਕੁੰਜੀ ਪ੍ਰਬੰਧਨ ਸਿਸਟਮ ਦੀ ਮੁੱਖ ਕੁੰਜੀ ਦਾ ਨਾਮ
kms_key_location: ਸਟ੍ਰਿੰਗ - ਉਹ ਖੇਤਰ ਜਿੱਥੇ ਤੁਹਾਡੇ ਕੁੰਜੀ ਪ੍ਰਬੰਧਨ ਸਿਸਟਮ ਦੀ ਮੁੱਖ ਕੁੰਜੀ ਮੌਜੂਦ ਹੈ
ਜੇ ਤੁਹਾਡਾ ਕੇਐੱਮਐੱਸ ਉਸ ਜੀਸੀਪੀ ਪ੍ਰੋਜੈਕਟ ਤੋਂ ਵੱਖਰੇ ਪ੍ਰੋਜੈਕਟ ਵਿੱਚ ਹੈ ਜਿੱਥੇ ਤੁਸੀਂ OpenAI ਦੀ ਵਰਕਲੋਡ ਪਛਾਣ ਰਜਿਸਟਰ ਕੀਤੀ ਹੈ, ਤਾਂ https://console.developers.google.com/apis/api/cloudkms.googleapis.com/overview 'ਤੇ ਜਾ ਕੇ ਯਕੀਨੀ ਬਣਾਓ ਕਿ OpenAI ਦੀ ਵਰਕਲੋਡ ਪਛਾਣ ਵਾਲੇ ਪ੍ਰੋਜੈਕਟ ਵਿੱਚ ਘੱਟੋ-ਘੱਟ ਕੇਐੱਮਐੱਸ ਚਾਲੂ ਹੈ.
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"
}ਅਜ਼ੂਰ
ਬੇਨਤੀ ਦਾ ਨਮੂਨਾ:
type: ਸਟ੍ਰਿੰਗ - ਹਮੇਸ਼ਾ “azure”,
name: ਸਟ੍ਰਿੰਗ - ਤੁਹਾਡੀ ਸੰਰਚਨਾ ਲਈ ਆਸਾਨੀ ਨਾਲ ਪਛਾਣਿਆ ਜਾ ਸਕਣ ਵਾਲਾ ਨਾਮ
tenant_id: ਸਟ੍ਰਿੰਗ - ਤੁਹਾਡੇ ਅਜ਼ੂਰ ਟੈਨੈਂਟ ਦਾ ਯੂਯੂਆਈਡੀ
vault_uri: ਸਟ੍ਰਿੰਗ - ਉਸ ਅਜ਼ੂਰ ਵਾਲਟ ਦਾ ਯੂਆਰਆਈ ਜਿਸ ਵਿੱਚ ਤੁਹਾਡੇ ਵੱਲੋਂ ਪ੍ਰਬੰਧਿਤ ਮੁੱਖ ਕੁੰਜੀ ਮੌਜੂਦ ਹੈ
key_name: ਸਟ੍ਰਿੰਗ - ਅਜ਼ੂਰ ਕੀ ਵਾਲਟ ਦੀ ਉਸ ਮੁੱਖ ਕੁੰਜੀ ਦਾ ਨਾਮ ਜਿਸ ਦਾ ਤੁਸੀਂ ਪ੍ਰਬੰਧਨ ਕਰਦੇ ਹੋ.
ਇਹ <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"
}ਆਪਣੀ ਸੰਸਥਾ ਵਿੱਚ ਰਜਿਸਟਰ ਕੀਤੀ ਬਾਹਰੀ ਕੁੰਜੀ ਮਿਟਾਓ
ਧਿਆਨ ਦਿਓ: ਤੁਸੀਂ ਬਾਹਰੀ ਕੁੰਜੀ ਸਿਰਫ਼ ਤਾਂ ਹੀ ਮਿਟਾ ਸਕਦੇ ਹੋ ਜੇ ਉਹ ਕਿਸੇ ਸਰਗਰਮ ਏਪੀਆਈ ਪ੍ਰੋਜੈਕਟ ਜਾਂ ਵਰਕਸਪੇਸ ਨਾਲ ਜੁੜੀ ਨਾ ਹੋਵੇ. ਜੇ ਉਹ ਕਿਸੇ ਸਰਗਰਮ ਏਪੀਆਈ ਪ੍ਰੋਜੈਕਟ ਨਾਲ ਜੁੜੀ ਹੈ, ਤਾਂ ਪਹਿਲਾਂ ਉਸ ਪ੍ਰੋਜੈਕਟ ਨੂੰ ਪੁਰਾਲੇਖ ਵਿੱਚ ਪਾਓ. ਜੇ ਉਹ ਕਿਸੇ ਵਰਕਸਪੇਸ ਨਾਲ ਜੁੜੀ ਹੈ, ਤਾਂ ਕੁੰਜੀ ਮਿਟਾਈ ਨਹੀਂ ਜਾ ਸਕਦੀ.
ਬੇਨਤੀ ਦਾ ਨਮੂਨਾ
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>"
}ਆਪਣੀ ਸੰਸਥਾ ਵਿੱਚ ਰਜਿਸਟਰ ਕੀਤੀਆਂ ਬਾਹਰੀ ਕੁੰਜੀਆਂ ਪ੍ਰਾਪਤ ਕਰੋ
ਬੇਨਤੀ ਦਾ ਨਮੂਨਾ
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 ਨਾਲ ਵੈਧ ਹੈ (ਤੁਹਾਨੂੰ ਸਫਲਤਾ ਦਰਸਾਉਂਦਾ ਜਵਾਬ ਮਿਲੇਗਾ).
ਤੁਹਾਡੀ ਕੁੰਜੀ ਨੂੰ ਰੱਦ ਕਰਨ ਦੀ ਕਾਰਵਾਈ ਸਹੀ ਢੰਗ ਨਾਲ ਕੀਤੀ ਗਈ ਹੈ, OpenAI ਇਸ 'ਤੇ ਪ੍ਰਕਿਰਿਆ ਕਰ ਰਿਹਾ ਹੈ, ਅਤੇ ਕੈਸ਼ ਦੀ 1 ਘੰਟੇ ਦੀ ਵੈਧਤਾ ਮਿਆਦ ਮੁੱਕਣ ਤੋਂ ਬਾਅਦ ਇਹ ਲਾਗੂ ਹੋ ਜਾਵੇਗੀ (ਤੁਹਾਨੂੰ ਤਰੁੱਟੀ ਦਰਸਾਉਂਦਾ ਜਵਾਬ ਮਿਲੇਗਾ).
ਬੇਨਤੀ ਦਾ ਨਮੂਨਾ
curl -X POST -H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys/extkey_xxx/validate"ਜਵਾਬ ਦਾ ਨਮੂਨਾ
{
"status": "success"
}ਜਾਂ, cloud provider ਵੱਲੋਂ ਕੋਈ ਗਲਤੀ ਸਾਹਮਣੇ ਆਈ.
ਪ੍ਰੋਜੈਕਟ-ਪੱਧਰ ਦੇ endpoints
ਬਾਹਰੀ ਕੁੰਜੀ ਆਈਡੀ ਨਾਲ ਨਵਾਂ ਪ੍ਰੋਜੈਕਟ ਬਣਾਓ
ਇਹ ਮੌਜੂਦਾ ਪ੍ਰੋਜੈਕਟ ਬਣਾਉਣ ਵਾਲੇ ਐਂਡਪੌਇੰਟ ਵਰਗਾ ਹੀ ਹੈ, ਪਰ ਬੇਨਤੀ ਅਤੇ ਜਵਾਬ ਵਿੱਚ 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"
}[ਪ੍ਰਤੀਬੰਧਿਤ] ਮੌਜੂਦਾ ਪ੍ਰੋਜੈਕਟ ਨੂੰ ਬਾਹਰੀ ਕੁੰਜੀ ਆਈਡੀ ਨਾਲ ਅੱਪਡੇਟ ਕਰੋ
ਇਹ ਮੌਜੂਦਾ ਪ੍ਰੋਜੈਕਟ ਅੱਪਡੇਟ ਕਰਨ ਵਾਲੇ ਐਂਡਪੌਇੰਟ ਵਰਗਾ ਹੀ ਹੈ, ਪਰ ਬੇਨਤੀ ਅਤੇ ਜਵਾਬ ਵਿੱਚ external_key_id ਪੈਰਾਮੀਟਰ ਵੀ ਸ਼ਾਮਲ ਕੀਤਾ ਗਿਆ ਹੈ.
ਅਸੀਂ ਤੁਹਾਡੇ ਈਕੇਐੱਮ ਕਾਰਜਾਂ ਲਈ ਨਵੇਂ ਏਪੀਆਈ ਪ੍ਰੋਜੈਕਟ ਬਣਾਉਣ ਦੀ ਸਿਫ਼ਾਰਸ਼ ਕਰਦੇ ਹਾਂ. ਜੇ ਤੁਸੀਂ ਆਪਣੇ ਸਾਰੇ ਮੌਜੂਦਾ ਏਪੀਆਈ ਪ੍ਰੋਜੈਕਟਾਂ 'ਤੇ ਈਕੇਐੱਮ ਚਾਹੁੰਦੇ ਹੋ, ਤਾਂ ਆਪਣੇ ਖਾਤਾ ਨਿਰਦੇਸ਼ਕ ਨੂੰ ਦੱਸੋ ਅਤੇ ਅਸੀਂ ਤੁਹਾਡੇ ਲਈ ਵਿਸ਼ੇਸ਼ਤਾ ਫਲੈਗ ਚਾਲੂ ਕਰ ਦੇਵਾਂਗੇ. ਆਪਣੇ ਮੌਜੂਦਾ ਅਸਲ ਵਰਤੋਂ ਵਾਲੇ ਪ੍ਰੋਜੈਕਟਾਂ ਵਿੱਚ ਈਕੇਐੱਮ ਲਾਗੂ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ ਕਿਰਪਾ ਕਰਕੇ ਹੇਠਾਂ ਦਿੱਤੇ ਵਧੀਆ ਅਭਿਆਸਾਂ ਦਾ ਧਿਆਨ ਰੱਖੋ.
ਏਪੀਆਈ ਦੀਆਂ ਉਹ ਸਾਰੀਆਂ ਵਿਸ਼ੇਸ਼ਤਾਵਾਂ ਜੋ ਤੁਸੀਂ ਅਸਲ ਵਰਤੋਂ ਵਿੱਚ ਲਿਆਉਂਦੇ ਹੋ, ਪਹਿਲਾਂ ਆਪਣੇ ਪਰਖ ਵਾਲੇ ਈਕੇਐੱਮ ਏਪੀਆਈ ਪ੍ਰੋਜੈਕਟ ਵਿੱਚ ਜਾਂਚੋ.
ਸਾਰੇ ਅਸਲ ਵਰਤੋਂ ਵਾਲੇ ਏਪੀਆਈ ਪ੍ਰੋਜੈਕਟਾਂ ਵਿੱਚ ਇੱਕੋ ਵਾਰ ਈਕੇਐੱਮ ਲਾਗੂ ਕਰਨ ਦੀ ਬਜਾਏ ਇਸ ਨੂੰ ਪੜਾਅਵਾਰ ਲਾਗੂ ਕਰੋ.
ਬੇਨਤੀ ਦਾ ਨਮੂਨਾ
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"
}'ਆਪਣੀ ਸੰਸਥਾ ਦੇ ਸਾਰੇ ਪ੍ਰੋਜੈਕਟਾਂ ਦੀ ਸੂਚੀ ਪ੍ਰਾਪਤ ਕਰੋ
ਇਹ ਮੌਜੂਦਾ ਐਂਡਪੌਇੰਟ ਵਰਗਾ ਹੀ ਹੈ, ਪਰ ਏਪੀਆਈ ਦੇ ਜਵਾਬ ਵਿੱਚ 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
}