Create a Credential - Barndoor Documentation
Create a credential
cURL
curl --request POST \
--url https://app.barndoor.ai/api/llm-gateway/admin/connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '\n{\n "name": "OpenAI Production",\n "model_provider": "openai",\n "base_url": "https://api.openai.com/v1",\n "auth_type": "api_key",\n "api_key": "sk-xxxxxxxxxxxxxxxxxxxx",\n "credentials": {},\n "settings": {}\n}\n'
import requests
url = "https://app.barndoor.ai/api/llm-gateway/admin/connections"
payload = {
"name": "OpenAI Production",
"model_provider": "openai",
"base_url": "https://api.openai.com/v1",
"auth_type": "api_key",
"api_key": "sk-xxxxxxxxxxxxxxxxxxxx",
"credentials": {},
"settings": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'OpenAI Production',
model_provider: 'openai',
base_url: 'https://api.openai.com/v1',
auth_type: 'api_key',
api_key: 'sk-xxxxxxxxxxxxxxxxxxxx',
credentials: {},
settings: {}
})
};
fetch('https://app.barndoor.ai/api/llm-gateway/admin/connections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php
$curl = curl_init();
curl_setopt_array($curl, [\
CURLOPT_URL => "https://app.barndoor.ai/api/llm-gateway/admin/connections",\
CURLOPT_RETURNTRANSFER => true,\
CURLOPT_ENCODING => "",\
CURLOPT_MAXREDIRS => 10,\
CURLOPT_TIMEOUT => 30,\
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
CURLOPT_CUSTOMREQUEST => "POST",\
CURLOPT_POSTFIELDS => json_encode([\
'name' => 'OpenAI Production',\
'model_provider' => 'openai',\
'base_url' => 'https://api.openai.com/v1',\
'auth_type' => 'api_key',\
'api_key' => 'sk-xxxxxxxxxxxxxxxxxxxx',\
'credentials' => [\
\
],\
'settings' => [\
\
]\
]),\
CURLOPT_HTTPHEADER => [\
"Authorization: Bearer <token>",\
"Content-Type: application/json"\
],\
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
?>
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.barndoor.ai/api/llm-gateway/admin/connections"
payload := strings.NewReader("{\n \"name\": \"OpenAI Production\",\n \"model_provider\": \"openai\",\n \"base_url\": \"https://api.openai.com/v1\",\n \"auth_type\": \"api_key\",\n \"api_key\": \"sk-xxxxxxxxxxxxxxxxxxxx\",\n \"credentials\": {},\n \"settings\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
HttpResponse<String> response = Unirest.post("https://app.barndoor.ai/api/llm-gateway/admin/connections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"OpenAI Production\",\n \"model_provider\": \"openai\",\n \"base_url\": \"https://api.openai.com/v1\",\n \"auth_type\": \"api_key\",\n \"api_key\": \"sk-xxxxxxxxxxxxxxxxxxxx\",\n \"credentials\": {},\n \"settings\": {}\n}")
.asString();
Responses
- 200 OK: The newly created credential
- 400 Bad Request: Error in request parameters
- 401 Unauthorized: Authentication failure
- 403 Forbidden: Access denied
{
"id": "4f8b2a3c-12ee-4d92-9c7b-e7d2f8b0a111",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "OpenAI Production",
"model_provider": "openai",
"auth_type": "api_key",
"base_url": "https://api.openai.com/v1",
"settings": {
"region": "us-east-1",
"model_api_family": "anthropic_messages"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
Error Responses
{
"error": "BadRequest",
"message": "request_timeout_secs must be between 1 and 3600"
}
Example
curl -X POST https://app.barndoor.ai/api/llm-gateway/admin/connections \
-H "Authorization: Bearer $BARNDOOR_JWT" \
-H "Content-Type: application/json" \
-d '{\n "name": "OpenAI Production",\n "model_provider": "openai",\n "base_url": "https://api.openai.com/v1",\n "api_key": "sk-..."\n }'
Authorizations
- Authorization: A string representing the JWT obtained through Barndoor's authentication flow. Pass the token verbatim in
Authorization: Bearer <token>.