حساب
همهٔ مسیرها نسبت به https://app.lobbe.ai/api/v1 هستند و هر درخواست Authorization: Bearer $LOBBE_TOKEN را می‌فرستد. مرجع API همهٔ مسیرها را فهرست می‌کند و فیلدهای x-lobbe-* را توضیح می‌دهد.
GET /account
Section titled “GET /account”حساب: صاحب آن، موجودی آن به دقیقه و تنظیمات آن.
| ویژگی | مقدار |
|---|---|
| دسترسی‌ها | account:read |
| دقیقه مصرف می‌کند | خیر |
| سقف درخواست‌ها | read: ۶۰۰ درخواست در هر ۱۰ دقیقه برای هر توکن |
| پاسخ موفق | 200 |
پاسخ 200
Section titled “پاسخ 200”حسابی که توکن از طرف آن کار می‌کند: صاحب، موجودی و تنظیمات آن؛ هرگز شمارهٔ موبایل یا نشانی ایمیل آن.
| فیلد | نوع | همیشه می‌آید | توضیح |
|---|---|---|---|
schemaVersion |
1 |
بله | در نسخهٔ ۱ API همیشه 1 |
owner |
object |
بله | کسی که توکن از طرف او کار می‌کند: صاحب حساب |
owner.type |
"user" |
بله | نوع صاحب حساب: امروز user؛ نوعی را که نمی‌شناسید نادیده بگیرید |
owner.id |
string |
بله | شناسهٔ حساب صاحب |
owner.displayName |
string | null |
بله | نام صاحب حساب؛ اگر نامی ثبت نشده باشد null است (شمارهٔ موبایل هرگز فرستاده نمی‌شود) |
wallet |
object |
بله | موجودی حساب |
wallet.balanceMinutes |
integer |
بله | موجودی به دقیقه؛ جلسه‌ای که هنوز رونوشتش آماده نشده هنوز از آن کم نشده است، و نخستین جلسه‌ای که از موجودی بیشتر باشد می‌تواند آن را زیر صفر ببرد |
settings |
object |
بله | تنظیماتی از حساب که توکن می‌بیند؛ updateAccountSettings سه مورد نخست را تغییر می‌دهد |
settings.speakerNamingMode |
"AUTO" | "FORCE_ON" | "FORCE_OFF" |
بله | این‌که جلسهٔ تازه چگونه منتظر نام گوینده‌ها می‌ماند: FORCE_ON («بپرس») آن را در NAMING نگه می‌دارد تا گوینده‌ها را نام‌گذاری کنید یا از نام‌گذاری رد شوید، یا naming.deadline آن بگذرد؛ AUTO («بپرس، ولی منتظر نمان») مدت کوتاهی نگهش می‌دارد و سپس ادامه می‌دهد؛ FORCE_OFF («حدس خودکار») هرگز نگهش نمی‌دارد و لُب در صورت امکان نام‌ها را حدس می‌زند |
settings.memoryLearningEnabled |
boolean |
بله | این‌که لُب از هر جلسهٔ تازه نکته‌های تازه به حافظه‌اش بیفزاید یا نه («یادگیری از جلسه‌های تازه» در برنامه)؛ false فقط یادگیری را متوقف می‌کند و نکته‌هایی که از قبل مانده‌اند همچنان به کار می‌روند |
settings.summaryEmailEnabled |
boolean |
بله | این‌که هر لُب تازه همراه فایل PDF آن به ایمیل صاحب حساب فرستاده شود یا نه («ارسال خلاصه پس از هر جلسه» در برنامه)؛ لُبی که دوباره ساخته شود دوباره فرستاده نمی‌شود، و تا وقتی حساب نشانی ایمیلی نداشته باشد چیزی فرستاده نمی‌شود (این نشانی فقط در برنامه ثبت می‌شود) |
settings.uiLocale |
"en" | "fa" |
بله | زبان برنامه برای این حساب، en یا fa: در برنامه تنظیم می‌شود، هرگز با توکن |
خطاها با { error: { code, message, details? } } پاسخ داده می‌شوند و code قرارداد است: خطاها را ببینید.
GET /account/keyterms
Section titled “GET /account/keyterms”واژگان حساب: واژه‌هایی که تبدیل گفتار به متن باید بشناسد.
| ویژگی | مقدار |
|---|---|
| دسترسی‌ها | account:read |
| دقیقه مصرف می‌کند | خیر |
| سقف درخواست‌ها | read: ۶۰۰ درخواست در هر ۱۰ دقیقه برای هر توکن |
| پاسخ موفق | 200 |
پاسخ 200
Section titled “پاسخ 200”واژگان حساب («واژگان من» در برنامه).
| فیلد | نوع | همیشه می‌آید | توضیح |
|---|---|---|---|
schemaVersion |
1 |
بله | در نسخهٔ ۱ API همیشه 1 |
keyterms[] |
string[] |
بله | واژه‌هایی که تبدیل گفتار به متن باید بشناسد، به ترتیبی که ذخیره شده‌اند (حداکثر ۱۰۰). جلسه‌ای که رونوشتش با واژگان ساخته شود، اگر در هیچ سری‌ای نباشد این واژه‌ها را به کار می‌برد، و اگر inheritAccountKeyterms سری‌اش true باشد پس از واژه‌های خود آن سری؛ جلسه‌ای در سری‌ای که این گزینه را نداشته باشد هرگز این واژه‌ها را به کار نمی‌برد |
خطاها با { error: { code, message, details? } } پاسخ داده می‌شوند و code قرارداد است: خطاها را ببینید.
PUT /account/keyterms
Section titled “PUT /account/keyterms”جایگزینی واژگان حساب؛ جلسه‌ای که از واژگان استفاده کند هزینهٔ افزودهٔ آن را دارد.
| ویژگی | مقدار |
|---|---|
| دسترسی‌ها | account:write |
| دقیقه مصرف می‌کند | خیر |
| سقف درخواست‌ها | settings: ۶۰ درخواست در هر ۱۰ دقیقه برای هر توکن |
| پاسخ موفق | 200 |
بدنهٔ درخواست (application/json)
Section titled “بدنهٔ درخواست (application/json)”کل واژگان حساب، به‌جای فهرست قبلی. هر جلسه همان واژه‌هایی را نگه می‌دارد که با آن فرستاده شد، و جلسه‌ای که از واژه‌ای استفاده کند ۲۰٪ هزینهٔ بیشتر دارد. فیلدی که این‌جا نیامده پاسخ 400 می‌گیرد.
| فیلد | نوع | الزامی | توضیح |
|---|---|---|---|
keyterms[] |
string[] |
بله | کل فهرست تازه. دو سر هر واژه پیراسته و هر رشته از فاصله‌هایش به یک فاصله تبدیل می‌شود؛ سپس حداکثر ۱۰۰ واژه، هر کدام ۱ تا ۴۹ نویسه و حداکثر ۵ کلمه که شامل هیچ‌یک از نویسه‌های <، >، {، }، [، ] یا \ نباشد، و بدون واژهٔ تکراری. فهرستی که یکی از این قاعده‌ها را رعایت نکند پاسخ 400 می‌گیرد و پیام آن نخستین مشکل را نام می‌برد |
پاسخ 200
Section titled “پاسخ 200”واژگان حساب («واژگان من» در برنامه).
| فیلد | نوع | همیشه می‌آید | توضیح |
|---|---|---|---|
schemaVersion |
1 |
بله | در نسخهٔ ۱ API همیشه 1 |
keyterms[] |
string[] |
بله | واژه‌هایی که تبدیل گفتار به متن باید بشناسد، به ترتیبی که ذخیره شده‌اند (حداکثر ۱۰۰). جلسه‌ای که رونوشتش با واژگان ساخته شود، اگر در هیچ سری‌ای نباشد این واژه‌ها را به کار می‌برد، و اگر inheritAccountKeyterms سری‌اش true باشد پس از واژه‌های خود آن سری؛ جلسه‌ای در سری‌ای که این گزینه را نداشته باشد هرگز این واژه‌ها را به کار نمی‌برد |
خطاها با { error: { code, message, details? } } پاسخ داده می‌شوند و code قرارداد است: خطاها را ببینید.
GET /account/memory
Section titled “GET /account/memory”آنچه لُب دربارهٔ صاحب حساب به یاد دارد، همان‌گونه که صفحهٔ تنظیمات نشان می‌دهد.
| ویژگی | مقدار |
|---|---|
| دسترسی‌ها | account:read |
| دقیقه مصرف می‌کند | خیر |
| سقف درخواست‌ها | read: ۶۰۰ درخواست در هر ۱۰ دقیقه برای هر توکن |
| پاسخ موفق | 200 |
پاسخ 200
Section titled “پاسخ 200”آنچه لُب دربارهٔ صاحب حساب به یاد دارد تا هر لُب دقیق‌تر شود، همان‌گونه که «حافظهٔ لُب» در برنامه نشان می‌دهد.
| فیلد | نوع | همیشه می‌آید | توضیح |
|---|---|---|---|
schemaVersion |
1 |
بله | در نسخهٔ ۱ API همیشه 1 |
memoryEnabled |
boolean |
بله | این‌که حافظه در لُب روشن است یا نه؛ تا وقتی false باشد items خالی است و ویرایش یا حذف نکته پاسخ 409 MEMORY_DISABLED می‌گیرد |
items[] |
object[] |
بله | نکته‌ها. یک نکتهٔ حافظه |
items[].id |
string |
بله | شناسهٔ نکته، همان‌که updateMemoryItem و deleteMemoryItem می‌گیرند |
items[].category |
"ABOUT_YOU" | "PEOPLE" | "TERMS" |
بله | بخشی که نکته در آن است: ABOUT_YOU («دربارهٔ شما»)، PEOPLE («آدم‌های تکرارشونده») یا TERMS («واژه‌های تخصصی») |
items[].text |
string |
بله | خود نکته |
items[].meetingCount |
integer |
بله | شمار جلسه‌هایی که نکته از آن‌ها یاد گرفته شد |
items[].pinned |
boolean |
بله | پس از آنکه صاحب حساب آن را ویرایش کند true است: از آن پس لُب هرگز آن را بازنویسی یا حذف نمی‌کند |
خطاها با { error: { code, message, details? } } پاسخ داده می‌شوند و code قرارداد است: خطاها را ببینید.
PATCH /account/settings
Section titled “PATCH /account/settings”تغییر نام‌گذاری گوینده‌ها، یادگیری حافظه یا ایمیل خلاصه؛ نه چیز دیگری.
| ویژگی | مقدار |
|---|---|
| دسترسی‌ها | account:write |
| دقیقه مصرف می‌کند | خیر |
| سقف درخواست‌ها | settings: ۶۰ درخواست در هر ۱۰ دقیقه برای هر توکن |
| پاسخ موفق | 200 |
بدنهٔ درخواست (application/json)
Section titled “بدنهٔ درخواست (application/json)”تنظیماتی که تغییر می‌کنند، دست‌کم یکی: فیلدی که نفرستید مقدارش را نگه می‌دارد، و هر فیلد دیگری پاسخ 400 می‌گیرد و چیزی نوشته نمی‌شود. دست‌کم یک فیلد بفرستید؛ بدنهٔ خالی پاسخ 400 می‌گیرد. فیلدی که این‌جا نیامده پاسخ 400 می‌گیرد.
| فیلد | نوع | الزامی | توضیح |
|---|---|---|---|
speakerNamingMode |
"AUTO" | "FORCE_ON" | "FORCE_OFF" |
خیر | این‌که جلسهٔ تازه چگونه منتظر نام گوینده‌ها می‌ماند: FORCE_ON («بپرس») آن را در NAMING نگه می‌دارد تا گوینده‌ها را نام‌گذاری کنید یا از نام‌گذاری رد شوید، یا naming.deadline آن بگذرد؛ AUTO («بپرس، ولی منتظر نمان») مدت کوتاهی نگهش می‌دارد و سپس ادامه می‌دهد؛ FORCE_OFF («حدس خودکار») هرگز نگهش نمی‌دارد و لُب در صورت امکان نام‌ها را حدس می‌زند |
memoryLearningEnabled |
boolean |
خیر | این‌که لُب از هر جلسهٔ تازه نکته‌های تازه به حافظه‌اش بیفزاید یا نه («یادگیری از جلسه‌های تازه» در برنامه)؛ false فقط یادگیری را متوقف می‌کند و نکته‌هایی که از قبل مانده‌اند همچنان به کار می‌روند |
summaryEmailEnabled |
boolean |
خیر | این‌که هر لُب تازه همراه فایل PDF آن به ایمیل صاحب حساب فرستاده شود یا نه («ارسال خلاصه پس از هر جلسه» در برنامه)؛ لُبی که دوباره ساخته شود دوباره فرستاده نمی‌شود، و تا وقتی حساب نشانی ایمیلی نداشته باشد چیزی فرستاده نمی‌شود (این نشانی فقط در برنامه ثبت می‌شود) |
پاسخ 200
Section titled “پاسخ 200”حسابی که توکن از طرف آن کار می‌کند: صاحب، موجودی و تنظیمات آن؛ هرگز شمارهٔ موبایل یا نشانی ایمیل آن.
| فیلد | نوع | همیشه می‌آید | توضیح |
|---|---|---|---|
schemaVersion |
1 |
بله | در نسخهٔ ۱ API همیشه 1 |
owner |
object |
بله | کسی که توکن از طرف او کار می‌کند: صاحب حساب |
owner.type |
"user" |
بله | نوع صاحب حساب: امروز user؛ نوعی را که نمی‌شناسید نادیده بگیرید |
owner.id |
string |
بله | شناسهٔ حساب صاحب |
owner.displayName |
string | null |
بله | نام صاحب حساب؛ اگر نامی ثبت نشده باشد null است (شمارهٔ موبایل هرگز فرستاده نمی‌شود) |
wallet |
object |
بله | موجودی حساب |
wallet.balanceMinutes |
integer |
بله | موجودی به دقیقه؛ جلسه‌ای که هنوز رونوشتش آماده نشده هنوز از آن کم نشده است، و نخستین جلسه‌ای که از موجودی بیشتر باشد می‌تواند آن را زیر صفر ببرد |
settings |
object |
بله | تنظیماتی از حساب که توکن می‌بیند؛ updateAccountSettings سه مورد نخست را تغییر می‌دهد |
settings.speakerNamingMode |
"AUTO" | "FORCE_ON" | "FORCE_OFF" |
بله | این‌که جلسهٔ تازه چگونه منتظر نام گوینده‌ها می‌ماند: FORCE_ON («بپرس») آن را در NAMING نگه می‌دارد تا گوینده‌ها را نام‌گذاری کنید یا از نام‌گذاری رد شوید، یا naming.deadline آن بگذرد؛ AUTO («بپرس، ولی منتظر نمان») مدت کوتاهی نگهش می‌دارد و سپس ادامه می‌دهد؛ FORCE_OFF («حدس خودکار») هرگز نگهش نمی‌دارد و لُب در صورت امکان نام‌ها را حدس می‌زند |
settings.memoryLearningEnabled |
boolean |
بله | این‌که لُب از هر جلسهٔ تازه نکته‌های تازه به حافظه‌اش بیفزاید یا نه («یادگیری از جلسه‌های تازه» در برنامه)؛ false فقط یادگیری را متوقف می‌کند و نکته‌هایی که از قبل مانده‌اند همچنان به کار می‌روند |
settings.summaryEmailEnabled |
boolean |
بله | این‌که هر لُب تازه همراه فایل PDF آن به ایمیل صاحب حساب فرستاده شود یا نه («ارسال خلاصه پس از هر جلسه» در برنامه)؛ لُبی که دوباره ساخته شود دوباره فرستاده نمی‌شود، و تا وقتی حساب نشانی ایمیلی نداشته باشد چیزی فرستاده نمی‌شود (این نشانی فقط در برنامه ثبت می‌شود) |
settings.uiLocale |
"en" | "fa" |
بله | زبان برنامه برای این حساب، en یا fa: در برنامه تنظیم می‌شود، هرگز با توکن |
خطاها با { error: { code, message, details? } } پاسخ داده می‌شوند و code قرارداد است: خطاها را ببینید.
PATCH /account/memory/{id}
Section titled “PATCH /account/memory/{id}”بازنویسی یک نکتهٔ حافظه؛ نکتهٔ ویرایش‌شده همان‌گونه که نوشته‌اید می‌ماند.
| ویژگی | مقدار |
|---|---|
| دسترسی‌ها | account:write |
| دقیقه مصرف می‌کند | خیر |
| سقف درخواست‌ها | settings: ۶۰ درخواست در هر ۱۰ دقیقه برای هر توکن |
| پاسخ موفق | 200 |
پارامترها
Section titled “پارامترها”| نام | محل | نوع | الزامی | توضیح |
|---|---|---|---|---|
id |
path |
string |
بله | شناسهٔ نکتهٔ حافظه |
بدنهٔ درخواست (application/json)
Section titled “بدنهٔ درخواست (application/json)”متن تازهٔ نکته؛ از آن پس نکته همان‌گونه که نوشته‌اید می‌ماند. فیلدی که این‌جا نیامده پاسخ 400 می‌گیرد.
| فیلد | نوع | الزامی | توضیح |
|---|---|---|---|
text |
string |
بله | متن تازه، پس از پیراستن دو سر آن: دست‌کم ۱ نویسه و حداکثر به اندازهٔ سقف برنامه برای یک نکته (هرگز بیش از ۱۰۰۰)؛ متن بلندتر پاسخ 400 می‌گیرد، و متنی که نکتهٔ دیگری در همان بخش دارد پاسخ 409 MEMORY_DUPLICATE |
پاسخ 200
Section titled “پاسخ 200”نکته با متن تازه‌اش.
| فیلد | نوع | همیشه می‌آید | توضیح |
|---|---|---|---|
schemaVersion |
1 |
بله | در نسخهٔ ۱ API همیشه 1 |
item |
object |
بله | یک نکتهٔ حافظه |
item.id |
string |
بله | شناسهٔ نکته، همان‌که updateMemoryItem و deleteMemoryItem می‌گیرند |
item.category |
"ABOUT_YOU" | "PEOPLE" | "TERMS" |
بله | بخشی که نکته در آن است: ABOUT_YOU («دربارهٔ شما»)، PEOPLE («آدم‌های تکرارشونده») یا TERMS («واژه‌های تخصصی») |
item.text |
string |
بله | خود نکته |
item.meetingCount |
integer |
بله | شمار جلسه‌هایی که نکته از آن‌ها یاد گرفته شد |
item.pinned |
boolean |
بله | پس از آنکه صاحب حساب آن را ویرایش کند true است: از آن پس لُب هرگز آن را بازنویسی یا حذف نمی‌کند |
خطاها با { error: { code, message, details? } } پاسخ داده می‌شوند و code قرارداد است: خطاها را ببینید.
DELETE /account/memory/{id}
Section titled “DELETE /account/memory/{id}”حذف یک نکتهٔ حافظه.
| ویژگی | مقدار |
|---|---|
| دسترسی‌ها | account:write |
| دقیقه مصرف می‌کند | خیر |
| سقف درخواست‌ها | settings: ۶۰ درخواست در هر ۱۰ دقیقه برای هر توکن |
| پاسخ موفق | 200 |
پارامترها
Section titled “پارامترها”| نام | محل | نوع | الزامی | توضیح |
|---|---|---|---|---|
id |
path |
string |
بله | شناسهٔ نکتهٔ حافظه |
پاسخ 200
Section titled “پاسخ 200”نکته برای همیشه حذف شد؛ ممکن است جلسه‌ای در آینده دوباره آن را به لُب یاد بدهد.
| فیلد | نوع | همیشه می‌آید | توضیح |
|---|---|---|---|
schemaVersion |
1 |
بله | در نسخهٔ ۱ API همیشه 1 |
id |
string |
بله | شناسهٔ نکتهٔ حذف‌شده |
deleted |
true |
بله | همیشه true |
خطاها با { error: { code, message, details? } } پاسخ داده می‌شوند و code قرارداد است: خطاها را ببینید.