BASE NG KAALAMAN

Sanggunian ng API

I-authenticate ang mga aplikasyon, bumuo ng teksto at mga imahe, lumikha ng mga embedding, at i-automate ang mga workflow ng provider, device at creator.

Tingnan bilang Markdown

Magsimula ditoPiliin ang tamang API at unawain ang mga karaniwang error.Mga TagabuoAuthorization ng aplikasyon, mga limitasyon sa paggastos ng customer, pagbawi sa pagsingil at integrasyon ng inference.Mga TagapagbigayPamahalaan ang mga katalogo ng provider at pagpepresyo, pagkatapos kontrolin ang mga indibidwal na device.Mga TagalikhaAuthentication ng creator, mga koleksyon, mga package ng modelo, at mga tag.

Gumawa ng iyong unang API request

Gumawa ng ShareAI API key, pumili ng magagamit na modelo, at magpadala ng chat request mula sa iyong server gamit ang Bearer authentication.

Piliin ang tamang API at kredensyal

Hanapin ang mga ShareAI API endpoint para sa application Auth, chat, Tugon, embeddings, imahe, Providers, Devices at Creators, gamit ang tamang URL at kredensyal.

Irehistro ang iyong aplikasyon

Gumawa ng aplikasyon, pumili ng modelo ng deployment nito at paganahin lamang ang mga kakayahan ng ShareAI na kailangan nito.

Mag-authorize ng account gamit ang PKCE

Gumamit ng authorization code kasama ang S256 PKCE para sa mga confidential at public na aplikasyon.

Pumili ng Login, Pay at AI scopes

Ang login, pagbabayad ng produkto at mga inference surcharge ay nangangailangan ng magkakahiwalay na kakayahan at authorization ng customer.

I-refresh ang access token

I-rotate ang refresh tokens nang hindi pinalalawak ang mga authorized scopes ng customer.

Basahin ang pagkakakilanlan at tuklasin ang mga Auth endpoint

Gamitin ang ShareAI Auth discovery, JWKS at UserInfo upang i-validate ang pag-sign-in ng application at basahin ang pagkakakilanlan na pinahintulutan ng isang OAuth access token.

I-revoke ang mga token at suriin ang server-side authorization

I-revoke ang mga hindi nagagamit na access at refresh tokens. Ang mga confidential na integrasyon ay maaari ring suriin ang estado ng token.

Unawain ang tinatanggap na mga kasunduan sa pagsingil

Panatilihin ang presyo ng subscription, interval at AI surcharge na nakatali sa mga tuntuning tinanggap ng bawat customer.

Gumawa ng kumpletong chat

Magpadala ng kahilingan sa ShareAI chat-completions gamit ang Bearer API key at unawain ang suportadong modelo, mga mensahe at stream fields.

Magpadala ng mga chat request gamit ang OAuth

Gumamit ng aprubadong ShareAI OAuth access token para sa mga chat completions na pinondohan ng customer at pangasiwaan ang expiry ng token, pahintulot at mga hangganan ng account.

Mag-stream ng tugon sa chat

Basahin ang ShareAI chat-completions server-sent events, i-append ang content deltas nang isang beses at hawakan ang completion, errors, at interrupted streams.

Suriin ang key access at pagkakakilanlan ng account

Basahin ang impormasyon ng ShareAI API key upang suriin ang mga limitasyon ng modelo at provider pati na rin ang pagkakakilanlan ng account na nauugnay sa isang inference credential.

Gumawa ng tugon sa teksto

Gamitin ang ShareAI Responses API para sa stateless text generation, explicit conversation history, at Responses streaming events.

Gumawa ng text embeddings

Bumuo ng text embeddings gamit ang ShareAI para sa semantic search, retrieval, at similarity, gamit ang mga suportadong input format at mga kinakailangan ng modelo.

Bumuo ng isang imahe

Lumikha ng mga imahe gamit ang ShareAI Images API gamit ang isang sinusuportahang modelo, isang text prompt at mga na-validate na opsyon sa pagbuo ng imahe.

I-authenticate ang Provider API

Paganahin ang Provider Remote Access at gamitin ang provider UUID at scoped access token para sa mga request sa catalog at pricing.

Ilista ang mga modelo ng provider at network

Basahin ang ShareAI Provider API network catalog, ang iyong provider catalog at eksaktong detalye ng modelo gamit ang provider_models:read.

I-update ang pagpepresyo ng modelo ng provider

Itakda ang input, output, at mga tier ng pagpepresyo ng cache ng modelo ng ShareAI provider gamit ang isang scoped Provider API token at isang eksaktong identifier ng modelo.

I-authenticate ang Device API

Gumawa ng isang partikular sa device na Remote Control token at unawain ang mga pagsusuri sa provider, device, at enabled-state para sa mga kahilingan ng ShareAI Device API.

Basahin ang mga sesyon ng device at kasaysayan ng gawain

Ilista ang mga sesyon ng device ng ShareAI at inspeksyunin ang history ng task ng isang sesyon gamit ang isang device-specific Remote Control token.

Simulan at ihinto ang pagbabahagi ng device

Magpadala ng mga utos ng pagbabahagi ng device ng ShareAI, tukuyin ang mga tinanggap na utos mula sa naobserbahang estado at beripikahin ang resulta sa Console.

I-authenticate ang Creator API

Gamitin ang creator-scoped Remote Access credentials at unawain ang koleksyon, modelo, at mga saklaw ng setting na magagamit sa ShareAI Creator API.

Basahin at pamahalaan ang mga koleksyon ng modelo

Ilista, lumikha, at i-update ang mga koleksyon ng modelo ng ShareAI Creator gamit ang kinakailangang mga saklaw at malinaw na mga hangganan ng pagmamay-ari at pagsusuri.

Gumawa ng package ng modelo

Lumikha ng metadata ng modelo ng ShareAI Creator, isang koleksyon, at mga tag ng modelo nang sabay-sabay, na may malinaw na patakaran sa pag-access at saklaw na mga kredensyal ng API.

Pamahalaan ang mga modelo sa loob ng isang koleksyon

Ilista, basahin, gumawa, at i-update ang mga tag ng modelo ng ShareAI Creator habang pinapanatili ang pagmamay-ari ng koleksyon nito at epektibong patakaran sa pag-serve.

Pangasiwaan ang mga error sa API at retries

I-diagnose ang mga error sa authentication, saklaw, access sa modelo, at availability ng ShareAI nang walang duplicate na pagsusulat o hindi ligtas na pag-refresh ng retries.

Unawain ang mga tagalikha ng modelo, mga identifier, at mga tag

Piliin ang eksaktong creator-based ShareAI model identifier, tuklasin ang pamilya nito at ikumpara ang mga provider na maaaring magpatakbo nito.

Pumili ng mga execution provider para sa isang API request

Gamitin ang ShareAI provider object upang pumili ng mga execution provider nang hiwalay mula sa tagalikha ng modelo sa lahat ng apat na inference endpoint.

Sanggunian sa patakaran ng provider

Sumangguni sa mga field ng ShareAI provider, mga default, limitasyon, at error para sa pagpili ng execution providers sa mga inference request.

Ayusin ang mga provider at kontrolin ang fallback

Unawain ang presyo, latency, at throughput ranking ng ShareAI, mga nakaayos na provider, hindi available na sukat, at ligtas na fallback na hangganan.

Unawain ang mga pagkakakilanlan ng customer

Ang bawat OAuth client ay tumatanggap ng ibang identifier para sa parehong ShareAI customer.

Magbayad para sa mga produkto at subscription

Gumawa ng wallet checkout, hayaan ang customer na kumpirmahin ito sa ShareAI, pagkatapos ay i-verify ang bayad na resulta bago ang fulfillment.

Ayusin ang mga error sa pagsingil at mga limitasyon sa paggastos ng customer

Tukuyin ang kakulangan sa credits mula sa limitasyon sa paggastos ng aplikasyon, magpakita ng actor-aware recovery link at ayusin nang tama ang mga streaming failure.