ShareAI Platform Docs
پایگاه دانش

مرجع API

احراز هویت برنامه‌ها، تولید متن و تصاویر، ایجاد جاسازی‌ها، و خودکارسازی گردش‌کارهای ارائه‌دهنده، دستگاه و سازنده.

مشاهده به‌صورت Markdown

اولین درخواست API خود را ارسال کنید

یک کلید API ShareAI ایجاد کنید، یک مدل موجود را انتخاب کنید و یک درخواست چت از سرور خود با احراز هویت Bearer ارسال کنید.

API و اعتبارنامه مناسب را انتخاب کنید

نقاط پایانی API ShareAI را برای احراز هویت برنامه، چت، پاسخ‌ها، جاسازی‌ها، تصاویر، ارائه‌دهندگان، دستگاه‌ها و سازندگان، با URL و اعتبارنامه صحیح پیدا کنید.

عملیات استنتاج و واحدهای صورتحساب

نقطه پایانی ShareAI، قابلیت‌ها و واحدهای قیمت‌گذاری مناسب برای هر نوع مدل را انتخاب کنید.

تولید تصاویر

پاسخ JSON هم‌زمان شامل نتایج تصویر در داده است.

برنامه خود را ثبت کنید

یک برنامه ایجاد کنید، مدل استقرار آن را انتخاب کنید و فقط قابلیت‌های ShareAI مورد نیاز آن را فعال کنید.

تولید ویدئوها

ارسال HTTP 202 را با شناسه کار ShareAI و URL نظرسنجی بازمی‌گرداند.

تولید گفتار

پاسخ موفقیت‌آمیز به صورت صوت باینری است، نه JSON.

رونویسی صوت

ارائه صوت base64 در input_audio.data و فرمت واقعی آن.

تصمیم‌گیری‌های ساختاریافته

از نقطه پایانی پایدار ShareAI /api/v1/decisions استفاده کنید.

رتبه‌بندی مجدد اسناد

یک پرسش و ۱–۱۰۰۰ سند ارائه دهید.

تولید صوت

نقطه پایانی ShareAI یک نتیجه صوتی JSON محدود را بازمی‌گرداند.

مجوز دادن به یک حساب با PKCE

از کد مجوز به‌علاوه S256 PKCE برای برنامه‌های محرمانه و عمومی استفاده کنید.

ورود، پرداخت و محدوده‌های AI را انتخاب کنید

ورود، محصول payments و inference هزینه‌های اضافی نیاز به قابلیت‌های جداگانه و تأیید مشتری دارند.

تازه‌سازی یک توکن دسترسی

چرخش توکن‌های تازه‌سازی بدون گسترش محدوده‌های مجاز مشتری.

هویت را بخوانید و نقاط پایانی احراز هویت را کشف کنید

از کشف احراز هویت ShareAI، JWKS و UserInfo برای اعتبارسنجی ورود به برنامه و خواندن هویت مجاز توسط یک توکن دسترسی OAuth استفاده کنید.

لغو توکن‌ها و بررسی مجوز سمت سرور

دسترسی و توکن‌های تازه‌سازی استفاده‌نشده را لغو کنید. یکپارچه‌سازی‌های محرمانه همچنین می‌توانند وضعیت توکن را بررسی کنند.

درک توافق‌نامه‌های صورتحساب پذیرفته شده

قیمت اشتراک، بازه زمانی و مارک‌آپ Builder را مطابق با شرایطی که هر مشتری پذیرفته است حفظ کنید.

یک تکمیل چت ایجاد کنید

یک درخواست تکمیل چت ShareAI را با کلید API Bearer ارسال کنید و مدل، پیام‌ها و فیلدهای جریان پشتیبانی‌شده را درک کنید.

درخواست‌های چت را با OAuth ارسال کنید

از یک توکن دسترسی ShareAI OAuth تأییدشده برای تکمیل‌های چت با تأمین مالی مشتری استفاده کنید و انقضای توکن، رضایت و مرزهای حساب را مدیریت کنید.

یک پاسخ چت را استریم کنید

رویدادهای ارسال‌شده توسط سرور تکمیل‌های چت ShareAI را بخوانید، دلتاهای محتوا را یک‌بار اضافه کنید و تکمیل، خطاها و جریان‌های قطع‌شده را مدیریت کنید.

دسترسی کلیدی و هویت حساب را بررسی کنید

اطلاعات کلید API ShareAI را بخوانید تا محدودیت‌های مدل و ارائه‌دهنده و هویت حساب مرتبط با اعتبار استنتاج را بررسی کنید.

ایجاد یک پاسخ متنی

از API پاسخ‌های ShareAI برای تولید متن بدون حالت، تاریخچه مکالمه صریح و رویدادهای جریان پاسخ‌ها استفاده کنید.

ایجاد جاسازی‌های متنی

جاسازی‌های متنی را با ShareAI برای جستجوی معنایی، بازیابی و شباهت، با فرمت‌های ورودی پشتیبانی‌شده و الزامات مدل تولید کنید.

تولید یک تصویر

ایجاد تصاویر با استفاده از ShareAI Images API با یک مدل پشتیبانی‌شده، یک متن ورودی و گزینه‌های تولید تصویر معتبر.

API ارائه‌دهنده را احراز هویت کنید

دسترسی از راه دور ارائه‌دهنده را فعال کنید و از UUID ارائه‌دهنده و توکن دسترسی محدود برای درخواست‌های کاتالوگ و قیمت‌گذاری استفاده کنید.

مدل‌های ارائه‌دهنده و شبکه را لیست کنید

کاتالوگ شبکه API ارائه‌دهنده ShareAI، کاتالوگ ارائه‌دهنده شما و جزئیات دقیق مدل را با استفاده از provider_models:read بخوانید.

قیمت‌گذاری مدل ارائه‌دهنده را به‌روزرسانی کنید

تنظیم ورودی، خروجی و سطوح قیمت‌گذاری کش مدل ارائه‌دهنده ShareAI با استفاده از یک توکن API ارائه‌دهنده محدود و یک شناسه مدل دقیق.

API دستگاه را احراز هویت کنید

ایجاد یک توکن کنترل از راه دور مخصوص دستگاه و درک بررسی‌های ارائه‌دهنده، دستگاه و حالت فعال‌شده برای درخواست‌های API دستگاه ShareAI.

جلسات دستگاه و تاریخچه وظایف را بخوانید

لیست جلسات دستگاه ShareAI و بررسی تاریخچه وظایف یک جلسه با استفاده از توکن کنترل از راه دور مخصوص دستگاه.

اشتراک‌گذاری دستگاه را شروع و متوقف کنید

ارسال دستورات اشتراک‌گذاری دستگاه ShareAI، تمایز دستورات پذیرفته‌شده از وضعیت مشاهده‌شده و تأیید نتیجه در کنسول.

API خالق را احراز هویت کنید

از اعتبارنامه‌های دسترسی از راه دور با محدوده Creator استفاده کنید و مجموعه، مدل و محدوده تنظیمات موجود در API Creator ShareAI را درک کنید.

مجموعه‌های مدل را بخوانید و مدیریت کنید

مجموعه‌های مدل Creator ShareAI را با محدوده‌های موردنیاز و مرزهای مالکیت و بررسی واضح فهرست کنید، ایجاد کنید و به‌روزرسانی کنید.

یک بسته مدل ایجاد کنید

ایجاد فراداده مدل ShareAI Creator، یک مجموعه و برچسب‌های مدل به‌صورت همزمان، با سیاست دسترسی مشخص و اعتبارنامه‌های API محدود.

مدل‌ها را در یک مجموعه مدیریت کنید

لیست، خواندن، ایجاد و به‌روزرسانی برچسب‌های مدل ShareAI Creator در حالی که مالکیت مجموعه و سیاست ارائه مؤثر آن‌ها حفظ می‌شود.

خطاهای API و تلاش‌های مجدد را مدیریت کنید

خطاهای احراز هویت، محدوده، دسترسی به مدل و دسترسی ShareAI را بدون نوشتن‌های تکراری یا تلاش‌های تازه‌سازی ناامن تشخیص دهید.

درک سازندگان مدل، شناسه‌ها و برچسب‌ها

یک شناسه مدل ShareAI مبتنی بر سازنده دقیق انتخاب کنید، خانواده آن را بررسی کنید و ارائه‌دهندگانی که می‌توانند آن را اجرا کنند مقایسه کنید.

انتخاب ارائه‌دهندگان اجرا برای درخواست API

از شیء ارائه‌دهنده ShareAI برای انتخاب ارائه‌دهندگان اجرا به‌صورت مستقل از سازنده مدل در تمام چهار نقطه پایانی استنتاج استفاده کنید.

مرجع سیاست ارائه‌دهنده

به فیلدهای ارائه‌دهنده ShareAI، پیش‌فرض‌ها، محدودیت‌ها و خطاها برای انتخاب ارائه‌دهندگان اجرا در درخواست‌های استنتاج مراجعه کنید.

مرتب‌سازی ارائه‌دهندگان و کنترل جایگزینی

رتبه‌بندی قیمت، تأخیر و توان عملیاتی ShareAI، ارائه‌دهندگان مرتب‌شده، اندازه‌گیری‌های غیرقابل‌دسترس و مرزهای ایمن جایگزین را درک کنید.

درک هویت‌های مشتری

هر کلاینت OAuth یک شناسه متفاوت برای همان مشتری ShareAI دریافت می‌کند.

پرداخت برای محصولات و اشتراک‌ها

یک پرداخت کیف پول ایجاد کنید، اجازه دهید مشتری آن را در ShareAI تأیید کند، سپس نتیجه پرداخت شده را قبل از تحقق تأیید کنید.

مدیریت خطاهای صورتحساب و محدودیت‌های هزینه مشتری

اعتبار ناکافی را از محدودیت هزینه برنامه متمایز کنید، لینک بازیابی آگاه به بازیگر ارائه دهید و شکست‌های جریان را به درستی مدیریت کنید.

مستندات پلتفرم ShareAI
تمام مستندات

جستجو بر اساس عنوان یا محتوا.

درباره این صفحه بپرسید

یک دستیار برای کاوش این صفحه انتخاب کنید. همچنین می‌توانید صفحه را کپی کرده و در مکالمه خود جای‌گذاری کنید.

Ask ChatGPTAsk ClaudeAsk GrokAsk ShareAI