API参考
验证应用程序,生成文本和图像,创建嵌入,并自动化提供者、设备和创建者的工作流程。
发起您的第一个 API 请求
创建一个ShareAI API密钥,选择一个可用模型,并从您的服务器发送带有Bearer认证的聊天请求。
选择合适的 API 和凭证
查找 ShareAI API 端点以进行应用认证、聊天、响应、嵌入、图像、提供者、设备和创作者操作,使用正确的 URL 和凭证。
注册您的应用程序
创建应用程序,选择其部署模型,并仅启用所需的 ShareAI 功能。
使用PKCE授权账户
对于机密和公共应用程序,使用授权代码加 S256 PKCE。
选择登录、支付和AI范围
登录、产品支付和推理附加费用需要单独的功能和客户授权。
刷新访问令牌
在不扩展客户授权范围的情况下轮换刷新令牌。
读取身份并发现认证端点
使用ShareAI认证发现、JWKS和UserInfo验证应用程序登录并读取OAuth访问令牌允许的身份。
撤销令牌并检查服务器端授权
撤销未使用的访问和刷新令牌。机密集成还可以检查令牌状态。
了解已接受的计费协议
将订阅价格、间隔和 AI 附加费用与每位客户接受的条款绑定。
创建一个聊天完成
使用 Bearer API 密钥发送 ShareAI 聊天完成请求,并了解支持的模型、消息和流字段。
使用 OAuth 发送聊天请求
使用批准的 ShareAI OAuth 访问令牌进行客户资助的聊天完成,并处理令牌过期、同意和账户边界。
流式传输聊天响应
阅读 ShareAI 聊天完成服务器发送事件,追加内容增量并处理完成、错误和中断的流。
检查密钥访问和账户身份
阅读 ShareAI API 密钥信息以检查模型和提供者限制,以及与推理凭证相关联的账户身份。
创建文本响应
使用 ShareAI 响应 API 进行无状态文本生成、显式对话历史记录和响应流事件。
创建文本嵌入
使用 ShareAI 生成文本嵌入,用于语义搜索、检索和相似性,支持的输入格式和模型要求。
生成图像
使用 ShareAI Images API 创建图像,需使用支持的模型、文本提示和验证的图像生成选项。
验证提供者 API
启用提供者远程访问,并使用提供者 UUID 和范围限定的访问令牌进行目录和定价请求。
列出提供者和网络模型
使用 provider_models:read 读取 ShareAI Provider API 网络目录、您的提供者目录以及确切的模型详情。
更新提供者模型定价
使用范围限定的 Provider API 令牌和精确的模型标识符设置 ShareAI 提供者模型输入、输出和缓存定价层级。
验证设备 API
创建特定设备的远程控制令牌,并了解 ShareAI 设备 API 请求的提供者、设备和启用状态检查。
读取设备会话和任务历史
列出ShareAI设备会话,并使用设备专属的远程控制令牌检查会话的任务历史记录。
开始和停止设备共享
发送ShareAI设备共享命令,区分已接受的命令与观察到的状态,并在Console中验证结果。
验证创作者 API
使用面向 Creator 的远程访问凭证,并了解 ShareAI Creator API 中可用的集合、模型和设置范围。
读取和管理模型集合
使用所需范围以及明确的所有权和审查边界,列出、创建和更新 ShareAI Creator 模型集合。
创建一个模型包
创建 ShareAI Creator 模型元数据、集合和模型标签,同时设置明确的访问策略和范围化的 API 凭证。
在集合中管理模型
列出、读取、创建和更新 ShareAI Creator 模型标签,同时保留其集合所有权和有效服务策略。
处理 API 错误和重试
诊断 ShareAI 身份验证、范围、模型访问和可用性错误,避免重复写入或不安全的刷新重试。
了解模型创建者、标识符和标签
选择基于创作者的准确ShareAI模型标识符,探索其系列并比较能够运行该模型的提供者。
为 API 请求选择执行提供者
使用ShareAI提供者对象独立选择执行提供者,而无需依赖模型创作者,在所有四个推理端点中均可实现。
提供者政策参考
参考 ShareAI 提供者字段、默认值、限制和错误,以选择推理请求中的执行提供者。
排序提供者并控制回退
了解ShareAI价格、延迟和吞吐量排名、排序后的提供者、不可用的测量值以及安全回退边界。
了解客户身份
每个 OAuth 客户端都会为同一 ShareAI 客户分配不同的标识符。
支付产品和订阅费用
创建钱包结账,让客户在 ShareAI 中确认,然后在履行之前验证支付结果。
处理账单错误和客户消费限额
区分余额不足与应用消费限额,呈现基于角色的恢复链接,并正确处理流式失败。