NXAI 文档

Appearance

runway ​

POST  v1/chat/completions

文生视频模型，已统一接口，可直接chat格式调用：runway-video、runway-vip-video（更快无水印）

请求参数 ​

Authorization ​

在 Header 添加参数 Authorization，其值为在 Bearer 之后拼接 Token。

Authorization: Bearer ******************

Header 参数 ​

参数类型必填说明示例
Content-Typestring可选请求体的数据格式类型application/json
Acceptstring可选客户端期望接收的响应数据格式application/json

Body 参数 ​

Content-Type: application/json

参数名类型必填说明
modelstring必需模型 ID。指定要使用的模型（如 gpt-4o, o1-preview, gpt-3.5-turbo）。
messagesarray [object]必需聊天记录。包含对话历史的对象数组。
├─ rolestring可选角色类型：user（用户）、assistant（助手）或 system（系统）。
└─ contentstring可选具体的文本内容。
streamboolean必需流式输出。设为 true 时，响应将通过服务器发送事件（SSE）逐块传输。
storeboolean可选存储设置。是否将此请求的输出存储用于模型蒸馏或评估。
modalitiesarray[string]可选输出模态。指定希望模型生成的输出类型。 • 默认：["text"] • 音频支持：["text", "audio"]（用于实时语音交互）。
reasoning_effortstring可选推理努力程度（仅限 o系列模型）。控制推理模型的计算量，可选 low, medium, high。较低的值可加快响应速度并减少推理 token。
metadataobject可选元数据。最多 16 个键值对，用于以结构化格式存储额外信息（键最长 64 字符，值最长 512 字符）。
predictionobject可选预测配置。当预先知道模型响应的大部分内容时使用（例如文件微调），可显著提高响应速度。
audioobject可选音频参数。当 modalities 包含 "audio" 时必须提供，用于配置语音输出的格式和声音。
temperaturenumber可选采样温度 (0-2)。值越高输出越随机，值越低输出越确定。建议只调整此参数或 top_p 其中之一。
top_pnumber可选核采样。例如 0.1 意味着只考虑概率质量前 10% 的 token。
ninteger可选生成数量。为每个输入生成多少个选择。保持 n=1 可降低成本。
stopstring可选停止序列。API 遇到这些序列时停止生成（最多 4 个）。注：最新的推理模型（如 o1, o3, o4-mini）不支持此参数。
max_completion_tokensinteger可选最大生成长度。生成的 token 上限（包含可见输出和推理 token）。
presence_penaltynumber可选存在惩罚 (-2.0 到 2.0)。正值增加模型讨论新话题的可能性。
frequency_penaltynumber可选频率惩罚 (-2.0 到 2.0)。正值降低模型逐字重复同一行的可能性。
logit_biasstring可选对数偏差。修改特定标记出现的概率（映射 token ID 到 -100 到 100 的偏差值）。
logprobsboolean可选对数概率。是否返回输出 token 的对数概率。
userstring可选用户标识。代表最终用户的唯一 ID，用于监控滥用行为。

请求示例 (JSON) ​

{
    "messages": [
        {
            "role": "user",
            "content": "![start.webp](https://filesystem.site/cdn/20240711/m5OZkhM2hIiT7sftXL5UvcAYvb9nye.webp) 熊猫从小吃到大"
        }
    ],
    "stream": true,
    "model": "runway-vip-video"
}

返回响应 ​

200 成功

Content-Type: application/json

响应参数 ​

参数类型必填说明
idstring必需聊天补全对象的唯一标识符。
objectstring必需对象类型，通常为 "chat.completion"。
createdinteger必需补全创建时的 Unix 时间戳（秒）。
modelstring必需用于生成此补全的模型。
choicesarray [object]必需模型生成的补全列表。
└─indexinteger可选此补全在其列表中的索引。
└─messageobject可选包含模型生成的响应消息的对象。
└─logprobsnull可选如果请求中设置了 logprobs，则包含标记的对数概率。
└─finish_reasonstring可选模型停止生成补全的原因。可能是 "stop"、"length" 或 "tool_calls"。
usageobject必需此补全请求使用的令牌统计信息。
└─prompt_tokensinteger必需提示中使用的令牌数量。
└─completion_tokensinteger必需补全中生成的令牌数量。
└─total_tokensinteger必需使用的总令牌数（提示 + 补全）。
└─prompt_tokens_detailsobject必需提示令牌的详细信息（例如缓存令牌）。
└─completion_tokens_detailsobject必需补全令牌的详细信息（例如推理令牌）。
service_tierstring必需用于处理请求的服务层级。
system_fingerprintstring必需用于监控后端变化的系统指纹。

响应示例 ​

{
    "id": "chatcmpl-123",
    "object": "chat.completion",
    "created": 1677652288,
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "\n\nHello there, how may I assist you today?"
            },
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 9,
        "completion_tokens": 12,
        "total_tokens": 21
    }
}

示例代码 ​

python
import http.client
import json

conn = http.client.HTTPSConnection("nxaiapp.com")
payload = json.dumps({
   "messages": [
      {
         "role": "user",
         "content": "![start.webp](https://filesystem.site/cdn/20240711/m5OZkhM2hIiT7sftXL5UvcAYvb9nye.webp) 熊猫从小吃到大"
      }
   ],
   "stream": True,
   "model": "runway-vip-video"
})
headers = {
   'Accept': 'application/json',
   'Authorization': 'Bearer <token>',
   'Content-Type': 'application/json'
}
conn.request("POST", "/v1/chat/completions", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))