ShareAI Platform Docs
BASIS PENGETAHUAN

Referensi API

Otentikasi aplikasi, nggawe teks lan gambar, nggawe embeddings, lan otomatisasi alur kerja panyedhiya, piranti lan kreator.

Deleng minangka Markdown

Gawe panjalukan API pisanan

Gawe kunci API ShareAI, pilih model sing kasedhiya lan kirim panjalukan obrolan saka server sampeyan nganggo otentikasi Bearer.

Pilih API lan kredensial sing pas

Temokake titik pungkasan API ShareAI kanggo otentikasi aplikasi, obrolan, Tanggapan, embeddings, gambar, Provider, Piranti lan Creator, kanthi URL lan kredensial sing bener.

Ndaftar aplikasi sampeyan

Gawe aplikasi, pilih model deployment lan aktifake mung kemampuan ShareAI sing dibutuhake.

Otorisasi akun nganggo PKCE

Gunakake kode otorisasi plus S256 PKCE kanggo aplikasi rahasia lan umum.

Pilih Login, Bayar lan lingkup AI

Login, pembayaran produk lan biaya tambahan inferensi mbutuhake kemampuan lan otorisasi pelanggan sing kapisah.

Refresh token akses

Puter token refresh tanpa nggedhekake lingkup sing wis diotorisasi pelanggan.

Waca identitas lan temokake titik akhir Auth

Gunakake ShareAI Auth discovery, JWKS lan UserInfo kanggo validasi mlebu aplikasi lan maca identitas sing diidini dening token akses OAuth.

Cabut token lan priksa otorisasi server-side

Cabut akses lan token refresh sing ora digunakake. Integrasi rahasia uga bisa mriksa status token.

Ngerti persetujuan billing sing ditampa

Tetepake rega langganan, interval, lan biaya tambahan AI sesuai karo syarat sing disetujoni saben pelanggan.

Gawe chat completion

Kirim panjalukan chat-completions ShareAI nganggo Bearer API key lan pahami model sing didhukung, pesen lan lapangan stream.

Kirim panjalukan chat nganggo OAuth

Gunakna token akses ShareAI OAuth sing disetujoni kanggo completion obrolan sing didanai pelanggan lan tangani kadaluwarsa token, persetujuan, lan watesan akun.

Stream tanggapan chat

Waca acara server-sent ShareAI chat-completions, tambahi delta konten sapisan lan tangani completion, kesalahan, lan aliran sing kaganggu.

Priksa akses kunci lan identitas akun

Waca informasi kunci API ShareAI kanggo mriksa watesan model lan panyedhiya lan identitas akun sing digandhengake karo kredensial inferensi.

Gawe tanggapan teks

Gunakake API Tanggapan ShareAI kanggo generasi teks tanpa status, riwayat obrolan eksplisit, lan acara streaming Tanggapan.

Gawe embeddings teks

Nggawe embeddings teks nganggo ShareAI kanggo telusuran semantik, pengambilan lan kemiripan, kanthi format input sing didhukung lan syarat model.

Nggawe gambar

Gawe gambar nganggo ShareAI Images API nggunakake model sing didhukung, prompt teks lan opsi generasi gambar sing divalidasi.

Otentikasi Provider API

Aktifake Akses Jarak Jauh Panyedhiya lan gunakake UUID panyedhiya lan token akses sing diwatesi kanggo panjalukan katalog lan rega.

Dhaptar model panyedhiya lan jaringan

Waca katalog jaringan API Provider ShareAI, katalog provider sampeyan, lan rincian model sing pas nggunakake provider_models:read.

Nganyari rega model panyedhiya

Setel tingkat rega input, output, lan cache model provider ShareAI nggunakake token API Provider sing lingkup lan pengenal model sing tepat.

Otentikasi Device API

Gawe token Remote Control khusus piranti lan ngerti provider, piranti, lan pemeriksaan status sing diaktifake kanggo panjalukan API Piranti ShareAI.

Waca sesi piranti lan riwayat tugas

Dhaptar sesi piranti ShareAI lan priksa riwayat tugas sesi nggunakake token Remote Control khusus piranti.

Miwiti lan mungkasi sharing piranti

Kirim perintah nuduhake piranti ShareAI, bedakake perintah sing ditampa saka status sing diamati lan verifikasi asil ing Console.

Otentikasi Creator API

Gunakake kredensial Remote Access sing diwatesi kanggo Creator lan pahami koleksi, model lan lingkup setelan sing kasedhiya ing ShareAI Creator API.

Waca lan ngatur koleksi model

Dhaptar, gawe lan nganyari koleksi model ShareAI Creator kanthi lingkup sing dibutuhake lan watesan kepemilikan lan review sing jelas.

Gawe paket model

Gawe metadata model ShareAI Creator, koleksi lan tag model bebarengan, kanthi kebijakan akses sing eksplisit lan kredensial API sing diwatesi.

Ngatur model ing koleksi

Dhaptar, waca, gawe lan nganyari tag model ShareAI Creator nalika njaga kepemilikan koleksi lan kebijakan layanan sing efektif.

Nggarap kesalahan API lan nyoba maneh

Diagnosa kesalahan otentikasi ShareAI, ruang lingkup, akses model lan kasedhiyan tanpa tulisan duplikat utawa upaya refresh sing ora aman.

Pahami panyipta model, pengenal lan tag

Pilih pengenal model ShareAI adhedhasar panyipta sing tepat, jelajahi keluargane lan bandhingake panyedhiya sing bisa nglakokake.

Pilih panyedhiya eksekusi kanggo panjalukan API

Gunakake obyek provider ShareAI kanggo milih provider eksekusi kanthi mandiri saka panyipta model ing kabeh papat titik akhir inferensi.

Referensi kebijakan panyedhiya

Rujuk lapangan provider ShareAI, default, watesan lan kesalahan kanggo milih provider eksekusi ing panjalukan inferensi.

Urutake panyedhiya lan kontrol fallback

Pahami rega, latensi lan throughput ShareAI, peringkat panyedhiya sing diurutake, pangukuran sing ora kasedhiya lan watesan fallback sing aman.

Ngerti identitas pelanggan

Saben klien OAuth nampa pengenal sing beda kanggo pelanggan ShareAI sing padha.

Mbayar produk lan langganan

Gawe checkout dompet, ngidini pelanggan konfirmasi ing ShareAI, banjur verifikasi asil sing wis dibayar sadurunge pemenuhan.

Nggarap kesalahan billing lan watesan belanja pelanggan

Bedakake kredit sing ora cukup saka watesan pengeluaran aplikasi, tampilake pranala pemulihan sing sadar aktor lan tangani kegagalan streaming kanthi bener.

Dokumen Platform ShareAI
Kabeh dokumentasi

Telusuri miturut judhul utawa isi.

Takon babagan kaca iki

Pilih asisten kanggo njelajah kaca iki. Sampeyan uga bisa nyalin kaca lan nempelake menyang obrolan sampeyan.

Ask ChatGPTAsk ClaudeAsk GrokAsk ShareAI