الانتقال إلى المحتوى الرئيسي
POST
إنشاء مفتاح API جديد
يتطلب هذا المسار مفتاح API للإدارة. ولا تُقبل مفاتيح Gateway API القياسية.
يُعاد مفتاح API بنصه الواضح مرة واحدة عند إنشائه. تُقبل حقول التوافق limit وlimit_reset وinclude_byok_in_limit؛ ويتعامل Phaseo حاليًا مع include_byok_in_limit لأغراض التوافق فقط ويستبعد BYOK دائمًا من حد هذا المفتاح.

التفويضات

Authorization
string
header
مطلوب

المصادقة باستخدام رمز Bearer

الجسم

application/json
name
string
مطلوب
Minimum string length: 1
مثال:

"Analytics Service Key"

workspace_id
string<uuid>

تجاوز اختياري لمساحة العمل للجهات المستدعية الداخلية.

scopes
مثال:

"[\"chat.completions\",\"responses\"]"

limit
number | null

حد إنفاق اختياري لهذا المفتاح بالدولار الأمريكي.

النطاق المطلوب: x >= 0
limit_reset
enum<string>

الفترة المستخدمة لنافذة حد الإنفاق.

الخيارات المتاحة:
daily,
weekly,
monthly
include_byok_in_limit
boolean

يُقبل للتوافق. يستثني سلوك Phaseo الحالي BYOK دائمًا من هذا الحد.

expires_at
string<date-time> | null
disabled
boolean
افتراضي:false
soft_blocked
boolean
افتراضي:false
limits
object
department_id
string<uuid> | null

القسم الذي ينتمي إليه هذا المفتاح لأغراض حدود المعدل وميزانيات القسم. تعني القيمة null أن المفتاح يُحتسب فقط ضمن حدود مساحة العمل بأكملها.

storage_locations
string[]

المكان الذي تحتفظ فيه بهذا المفتاح، مثل منصة الاستضافة التي تحتفظ به في متغيرات البيئة. اختياري. إذا أبلغ أحد هذه الأماكن عن اختراق، يمكنك العثور على كل المفاتيح المخزنة فيه وإبطالها. المعرّفات المعروفة: railway, vercel, netlify, render, fly, heroku, cloudflare, supabase, firebase, digitalocean, replit, modal, convex, koyeb, coolify, northflank, expo, deno-deploy, aws, google-cloud, azure, hetzner, vultr, linode, ovhcloud, scaleway, kubernetes, github, gitlab, circleci, bitbucket, 1password, bitwarden, hashicorp-vault, doppler, infisical, local-machine, own-server, other.

Maximum array length: 8
Pattern: ^[a-z0-9][a-z0-9-]{0,39}$
مثال:

الاستجابة

تم إنشاء مفتاح API

key
string
مطلوب

مفتاح API بنص صريح، بالقيمة نفسها الموجودة في data.key. يُعرض مرة واحدة فقط عند إنشائه.

مثال:

"phaseo_v1_sk_abcd1234_supersecretvalue"

data
object
مطلوب
آخر تعديل في ١٦ نوفمبر ٢٠٢٦