Skip to main content
POST
/
v1
/
external-apis
Create External API Configuration
curl --request POST \
  --url https://api.bey.dev/v1/external-apis \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "api_key": "<string>",
  "type": "openai_compatible_llm"
}
'
import requests

url = "https://api.bey.dev/v1/external-apis"

payload = {
"name": "<string>",
"url": "<string>",
"api_key": "<string>",
"type": "openai_compatible_llm"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
api_key: '<string>',
type: 'openai_compatible_llm'
})
};

fetch('https://api.bey.dev/v1/external-apis', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "type": "openai_compatible_llm"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

x-api-key
string
header
required

Your Beyond Presence API Key.

Body

application/json

External API configuration data.

name
string
required
url
string
required
api_key
string<password>
required
write-only
type
string
default:openai_compatible_llm
Allowed value: "openai_compatible_llm"

Response

Created External API Configuration with ID

Response body for an OpenAI-compatible LLM API configuration.

id
string
required

Unique identifier of the object in the database.

Example:

"01234567-89ab-cdef-0123-456789abcdef"

name
string
required
url
string
required
type
string
default:openai_compatible_llm
Allowed value: "openai_compatible_llm"