توکن
همهٔ مسیرها نسبت به https://app.lobbe.ai/api/v1 هستند و هر درخواست Authorization: Bearer $LOBBE_TOKEN را می‌فرستد. مرجع API همهٔ مسیرها را فهرست می‌کند و فیلدهای x-lobbe-* را توضیح می‌دهد.
GET /whoami
Section titled “GET /whoami”این توکن متعلق به کیست، چه دسترسی‌هایی دارد، سقف روزانه‌اش و محدودیت‌های ارسال.
| ویژگی | مقدار |
|---|---|
| دسترسی‌ها | هر توکن فعال |
| دقیقه مصرف می‌کند | خیر |
| سقف درخواست‌ها | read: ۶۰۰ درخواست در هر ۱۰ دقیقه برای هر توکن |
| پاسخ موفق | 200 |
پاسخ 200
Section titled “پاسخ 200”این توکن از طرف چه کسی کار می‌کند و چه کارهایی می‌تواند بکند.
| فیلد | نوع | همیشه می‌آید | توضیح |
|---|---|---|---|
schemaVersion |
1 |
بله | در نسخهٔ ۱ API همیشه 1 |
owner |
object |
بله | کسی که توکن از طرف او کار می‌کند: صاحب حساب |
owner.type |
"user" |
بله | نوع صاحب حساب: امروز user؛ نوعی را که نمی‌شناسید نادیده بگیرید |
owner.id |
string |
بله | شناسهٔ حساب صاحب |
owner.displayName |
string | null |
بله | نام صاحب حساب؛ اگر نامی ثبت نشده باشد null است (شمارهٔ موبایل هرگز فرستاده نمی‌شود) |
token |
object |
بله | توکنی که این درخواست را فرستاده است |
token.id |
string |
بله | شناسهٔ توکن |
token.name |
string |
بله | نامی که صاحب حساب به توکن داده است |
token.scopes[] |
("recordings:read" | "recordings:write" | "recordings:query" | "series:read" | "series:write" | "series:query" | "account:read" | "account:write")[] |
بله | دسترسی‌هایی که توکن دارد، به ترتیب فهرست؛ هر کدام یکی از recordings:read، recordings:write، recordings:query، series:read، series:write، series:query، account:read یا account:write است |
token.dailyMinuteCap |
integer | null |
بله | بیشترین دقیقه‌ای که توکن در هر ۲۴ ساعت پشت سر هم می‌تواند خرج کند؛ null یعنی نامحدود |
token.usedMinutes24h |
integer |
بله | دقیقه‌هایی که توکن در ۲۴ ساعت گذشته خرج کرده است، همان جمعی که با سقف روزانه سنجیده می‌شود |
token.expiresAt |
string | null |
بله | زمانی که توکن از کار می‌افتد (ISO 8601، به وقت UTC)؛ null یعنی بدون انقضا |
wallet |
object | null |
بله | موجودی حساب؛ اگر توکن دسترسی account:read نداشته باشد null است |
wallet.balanceMinutes |
integer |
بله | موجودی به دقیقه؛ جلسه‌ای که هنوز رونوشتش آماده نشده هنوز از آن کم نشده است، و نخستین جلسه‌ای که از موجودی بیشتر باشد می‌تواند آن را زیر صفر ببرد |
limits |
object |
بله | محدودیت‌های هر ارسال |
limits.maxUploadMb |
number |
بله | بزرگ‌ترین فایل صوتی پذیرفته‌شده، به مگابایت |
limits.maxRecordingMinutes |
number |
بله | طولانی‌ترین جلسهٔ پذیرفته‌شده، به دقیقهٔ صدا |
خطاها با { error: { code, message, details? } } پاسخ داده می‌شوند و code قرارداد است: خطاها را ببینید.