万邦openai自定义API操作 API 返回值说明

custom-自定义API操作 [查看演示] API测试工具 注册开通

openai.custom

公共参数

请求地址: https://api-gw.onebound.cn/openai/custom

名称 类型 必须 描述
keyString调用key(必须以GET方式拼接在URL中)
secretString调用密钥
api_nameStringAPI接口名称(包括在请求地址中)[item_search,item_get,item_search_shop等]
cacheString[yes,no]默认yes,将调用缓存的数据,速度比较快
result_typeString[json,jsonu,xml,serialize,var_export]返回数据格式,默认为json,jsonu输出的内容中文可以直接阅读
langString[cn,en,ru]翻译语言,默认cn简体中文
versionStringAPI版本
请求参数

请求参数:method=&_o_args=
我司的openai专用API域名:https://api-ai.onebound.cn/

参数说明: 文本模式参数:&_o_args={"prompt": "中国队什么时候进世界杯","max_tokens":200} prompt 文本,max_token 词汇最大量
图片模式参数:&_o_args={"prompt":"地球","n":10} prompt 图片描述文本,n 返回图片数
api:openAI开放平台的接口名(如:v1/completions)
其它参数:参考官方平台接口文档,与官方的参数一致
MJ图片生成参数:method=images/submit&_o_args={"prompt":"向日葵"}(生成图片id), method=images/get&_o_args={"imgid":"1987378144113570"}(图片id生成图片)

名称 类型 必须 描述
methodString接口名,如:
v1/models(模型),
v1/completions( AI问答 ),
v1/chat/completions(对话),
v1/edits(编辑文本,优化文本信息),
v1/images/generations( 文本生图 ),
v1/images/edits(图片编辑),
v1/images/variations(图片修改),
v1/embeddings(学习模型),
v1/audio/transcriptions(声音转换、翻译),
v1/files(文件微调、修改),
images/submit(文本生成图片id),
images/get(图片id生成图片),
……………………
_o_argsStringjson数组格式,如{"prompt": "中国队什么时候进世界杯","max_tokens":200}
[其他参数]String其它参数:参考OpenAI开放平台接口文档,与官方的参数一致
https://platform.openai.com/
响应参数

Version: Date:

名称 类型 必须 示例值 描述
response
Mix 0 [] 响应内容,不同的接口返回内容不一样,具体参考 https://platform.openai.com/
请求示例
	
-- 请求示例 url 默认请求参数已经URL编码处理
curl -i "https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method="
<?php

// 请求示例 url 默认请求参数已经URL编码处理
// 本示例代码未加密secret参数明文传输,若要加密请参考:https://open.onebound.cn/help/demo/sdk/demo-sign.php
$method = "GET";
$url = "https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method=";
$curl = curl_init();
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST,FALSE);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER,FALSE);
curl_setopt($curl, CURLOPT_FAILONERROR, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HEADER, true);
curl_setopt($curl, CURLOPT_ENCODING, "gzip");
var_dump(curl_exec($curl));
?>
<?php
//定义缓存目录和引入文件
define("DIR_RUNTIME","runtime/");
define("DIR_ERROR","runtime/");
define("SECACHE_SIZE","0");
//SDK下载地址 https://open.onebound.cn/help/demo/sdk/onebound-api-sdk.zip
include ("ObApiClient.php");

$obapi = new otao\ObApiClient();
$obapi->api_url = "http://api-gw.onebound.cn/";
$obapi->api_urls = array("http://api-gw.onebound.cn/","http://api-1.onebound.cn/");//备用API服务器
$obapi->api_urls_on = true;//当网络错误时,是否启用备用API服务器
$obapi->api_key = "<您自己的apiKey>";
$obapi->api_secret = "<您自己的apiSecret>";
$obapi->api_version ="";
$obapi->secache_path ="runtime/";
$obapi->secache_time ="86400";
$obapi->cache = true;

$api_data = $obapi->exec(
                array(
	                "api_type" =>"openai",
	                "api_name" =>"custom",
	                "api_params"=>array (
  'method' => '',
)
                )
            );
 var_dump($api_data);
?>
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.net.URL;
import java.nio.charset.Charset;
import org.json.JSONException;
import org.json.JSONObject;
import java.io.PrintWriter;
import java.net.URLConnection;

public class Example {
	private static String readAll(Reader rd) throws IOException {
		StringBuilder sb = new StringBuilder();
		int cp;
		while ((cp = rd.read()) != -1) {
			sb.append((char) cp);
		}
		return  sb.toString();
	}
	public static JSONObject postRequestFromUrl(String url, String body) throws IOException, JSONException {
		URL realUrl = new URL(url);
		URLConnection conn = realUrl.openConnection();
		conn.setDoOutput(true);
		conn.setDoInput(true);
		PrintWriter out = new PrintWriter(conn.getOutputStream());
		out.print(body);
		out.flush();
		InputStream instream = conn.getInputStream();
		try {
			BufferedReader rd = new BufferedReader(new InputStreamReader(instream, Charset.forName("UTF-8")));
			String jsonText = readAll(rd);
			JSONObject json = new JSONObject(jsonText);
			return json;
		} finally {
			instream.close();
		}
	}
	public static JSONObject getRequestFromUrl(String url) throws IOException, JSONException {
		URL realUrl = new URL(url);
		URLConnection conn = realUrl.openConnection();
		InputStream instream = conn.getInputStream();
		try {
			BufferedReader rd = new BufferedReader(new InputStreamReader(instream, Charset.forName("UTF-8")));
			String jsonText = readAll(rd);
			JSONObject json = new JSONObject(jsonText);
			return json;
		} finally {
			instream.close();
		}
	}
	public static void main(String[] args) throws IOException, JSONException {
		// 请求示例 url 默认请求参数已经URL编码处理
		String url = "https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method=";
		JSONObject json = getRequestFromUrl(url);
		System.out.println(json.toString());
	}

}
//using System.Net.Security;
//using System.Security.Cryptography.X509Certificates;
private const String method = "GET";
static void Main(string[] args)
{
	String bodys = "";
	// 请求示例 url 默认请求参数已经做URL编码
	String url = "https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method=";
	HttpWebRequest httpRequest = null;
	HttpWebResponse httpResponse = null; 
	if (url.Contains("https://"))
	{
		ServicePointManager.ServerCertificateValidationCallback = new RemoteCertificateValidationCallback(CheckValidationResult);
		httpRequest = (HttpWebRequest)WebRequest.CreateDefault(new Uri(url));
	}
	else
	{
		httpRequest = (HttpWebRequest)WebRequest.Create(url);
	}
	httpRequest.Method = method;
	if (0 < bodys.Length)
	{
		byte[] data = Encoding.UTF8.GetBytes(bodys);
		using (Stream stream = httpRequest.GetRequestStream())
		{
		stream.Write(data, 0, data.Length);
		}
	}
	try
	{
		httpResponse = (HttpWebResponse)httpRequest.GetResponse();
	}
	catch (WebException ex)
	{
		httpResponse = (HttpWebResponse)ex.Response;
	}
	Console.WriteLine(httpResponse.StatusCode);
	Console.WriteLine(httpResponse.Method);
	Console.WriteLine(httpResponse.Headers);
	Stream st = httpResponse.GetResponseStream();
	StreamReader reader = new StreamReader(st, Encoding.GetEncoding("utf-8"));
	Console.WriteLine(reader.ReadToEnd());
	Console.WriteLine("\n");
}
public static bool CheckValidationResult(object sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors errors)
{
	return true;
}
# coding:utf-8
"""
Compatible for python2.x and python3.x
requirement: pip install requests
"""
from __future__ import print_function
import requests
# 请求示例 url 默认请求参数已经做URL编码
url = "https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method="
headers = {
    "Accept-Encoding": "gzip",
    "Connection": "close"
}
if __name__ == "__main__":
    r = requests.get(url, headers=headers)
    json_obj = r.json()
    print(json_obj)
url := fmt.Sprintf("https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method=", params)
req, err := http.NewRequest("GET", url, nil)
if err != nil {
    panic(err)
}
req.Header.Set("Authorization", apiKey)

client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
    panic(err)
}
defer resp.Body.Close()

body, err := ioutil.ReadAll(resp.Body)
if err != nil {
    panic(err)
}

fmt.Println(string(body))
fetch('https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"method":""})// request parameters here
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));
<script src="js/obapi.js"></script>
<script type="text/javascript">
obAPI.config({
    debug: true, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印。
    api_url: "https://api-gw.onebound.cn", // 
    api_key: "<您自己的apiKey>", // 必填,
    api_secret: "<您自己的apiSecret>", //
    lang: "cn", // 
    timestamp: "", // 必填,生成签名的时间戳
    nonceStr: "", // 必填,生成签名的随机串
    signature: "",// 必填,签名
    jsApiList: [] // 必填,需要使用的JS接口列表
});
</script>
<div id="api_data_box"></div>
<script type="text/javascript">
obAPI.exec(
     {
     "api_type":"openai",
     "api_name" : "custom",
     "api_params": {"method":""}//method=,#具体参数请参考文档说明
     },
     function(e){
        document.querySelector("#api_data_box").innerHTML=JSON.stringify(e)
     }
);
</script>
require "net/http"
require "uri"
url = URI("https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body 
import Foundation
 
let url = URL(string: "https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method=")!
let task = URLSession.shared.dataTask(with: url) { data, response, error in
    guard let data = data else {
        print("Error: No data was returned")
        return
    }
     
    if let data = String(data: data, encoding: .utf8) {
        print(data)
    }
}
task.resume()
NSURL *myUrl = [NSURL URLWithString:@"https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method="];

NSMutableURLRequest *request=[NSMutableURLRequest requestWithURL:myUrl cachePolicy:NSURLRequestReloadIgnoringCacheData timeoutInterval:60.0];

[request setHTTPMethod:@"GET"];
NSError *error;
NSURLResponse *response;

NSData *data = [NSURLConnection sendSynchronousRequest:request returningResponse:&response error:&error];

NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
NSLog(@"%@",result);
#include<stdio.h>
#include <stdlib.h>
#include<string.h>
#include<curl/curl.h>

int main(){
  CURL *curl;  
  CURLcode res;   
  struct curl_slist *headers=NULL; 

  char url[] = "https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method=";
  curl_global_init(CURL_GLOBAL_ALL); 
  curl = curl_easy_init(); 

  if(curl) {
    curl_easy_setopt(curl, CURLOPT_URL,url);
    headers = curl_slist_append(headers, "Content-Type: application/json"); 

    curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers); 
    res = curl_easy_perform(curl);

    if(res != CURLE_OK){
      printf("curl_easy_perform(): %s\n",curl_easy_strerror(res));                     
    }
    curl_easy_cleanup(curl);          
  }
  curl_global_cleanup();
  return 0;
}
#include<iostream>
#include<string>
#include<curl/curl.h>

using namespace std;

static size_t Data(void *ptr, size_t size, size_t nmemb, string *stream)
{
    std::size_t realSize = size *nmemb;
    auto *realPtr = reinterpret_cast<char *>(ptr);

    for (std::size_t i=0;i<realSize;++i) {
        *(stream) += *(realPtr + i);
    }

    return realSize;
}

int main(){

     CURL *curl;
     CURLcode result;
     string readBuffer;
     curl = curl_easy_init();

     if(curl) {

         curl_easy_setopt(curl, CURLOPT_URL, "https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method=");
         curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
         curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, Data);
         curl_easy_setopt(curl, CURLOPT_WRITEDATA, &readBuffer);

         result = curl_easy_perform(curl);

         if(result == CURLE_OK) {
             cout<<readBuffer<<endl;
         }else{
             cerr<<"curl_easy error:"<<curl_easy_strerror(result)<<endl;
         }

         curl_easy_cleanup(curl);
     }
     return 0;
}
const https = require("https");

https.get("https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method=", (resp) => {
  let data = "";

  resp.on("data", (chunk) => {
    data += chunk;
  });

  resp.on("end", () => {
    console.log(data);
  });
}).on("error", (err) => {
  console.log("Error: " + err.message);
});
import java.net.HttpURLConnection
import java.net.URL

fun main() {
    val url = URL("https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method=")
    val con = url.openConnection() as HttpURLConnection
    con.requestMethod = "GET"

    val responseCode = con.responseCode
    if (responseCode == HttpURLConnection.HTTP_OK) { // success
        val inputLine = con.inputStream.bufferedReader().use { it.readText() }
        println(inputLine)
    } else {
        println("GET request failed")
    }
}
use std::io::{self, Read};
use reqwest;

fn main() -> io::Result<()> {

    let mut resp = reqwest::get("https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method=")?;
    let mut content = String::new();
    resp.read_to_string(&mut content)?;

    println!("{}", content);

    Ok(())
}

library(httr)
r <- GET("https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method=")
content(r)
url = "https://api-gw.onebound.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method=";
response = webread(url);
disp(response);
响应示例
{
	"response": {
		"id": "cmpl-6qY0bIoPXYs7nCMME3g9buaZcxbf6",
		"object": "text_completion",
		"created": 1677981805,
		"model": "text-davinci-003",
		"choices": [
			{
				"text": "\n\n按中国富豪榜排名,中国最有钱的人是马云。",
				"index": 0,
				"logprobs": null,
				"finish_reason": "stop"
			}
		],
		"usage": {
			"prompt_tokens": 16,
			"completion_tokens": 43,
			"total_tokens": 59
		}
	},
	"error": "",
	"reason": "",
	"error_code": "0000",
	"request_id": "1.6403f86cd67f6",
	"last_id": "1593583206"
}
异常示例
{
	"response": {
		"error": {
			"message": "Rate limit reached for default-text-davinci-003 in organization org-s1mHAqazDVEDzVLaYDlHtn4z on tokens per min. Limit: 150000 / min. Current: 2000000 / min. Contact support@openai.com if you continue to have issues. Please add a payment method to your account to increase your rate limit. Visit https://platform.openai.com/account/billing to add a payment method.",
			"type": "tokens",
			"param": null,
			"code": null
		}
	},
	"error_code": "2000",
	"error": "",
	"reason": "",
	"request_id": "1.6403fb3e09647",
	"last_id": "1593602602"
}
相关资料
ChatGPT、Bard、LLaMa、文心一言、MOSS等人工智能应用聚合平台
错误码解释
状态代码(error_code) 状态信息 详细描述 是否收费
0000success接口调用成功并返回相关数据
2000Search success but no result接口访问成功,但是搜索没有结果
4000Server internal error服务器内部错误
4001Network error网络错误
4002Target server error目标服务器错误
4003Param error用户输入参数错误忽略
4004Account not found用户帐号不存在忽略
4005Invalid authentication credentials授权失败忽略
4006API stopped您的当前API已停用忽略
4007Account stopped您的账户已停用忽略
4008API rate limit exceeded并发已达上限忽略
4009API maintenanceAPI维护中忽略
4010API not found with these valuesAPI不存在忽略
4012Please add api first请先添加api忽略
4013Number of calls exceeded调用次数超限忽略
4014Missing url param参数缺失忽略
4015Wrong pageToken参数pageToken有误忽略
4016Insufficient balance余额不足忽略
4017timeout error请求超时
5000unknown error未知错误
API 工具
如何获得此API
立即开通 有疑问联系客服QQ:QQ:31424016063142401606(微信同号)