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": "01234567-89ab-cdef-0123-456789abcdef",
"name": "<string>",
"url": "<string>",
"type": "openai_compatible_llm"
}Agents External APIs
Create External API Configuration
Create an external API configuration.
Securely stores credentials for an external service (such as an OpenAI-compatible LLM or your ElevenLabs account) so agents can reference it by ID. The secret itself is never returned in responses. Fails if the service rejects the key, which is only checked for ElevenLabs so far.
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": "01234567-89ab-cdef-0123-456789abcdef",
"name": "<string>",
"url": "<string>",
"type": "openai_compatible_llm"
}Authorizations
Your Beyond Presence API Key.
Body
application/json
Response
Created External API Configuration with ID
- OpenaiCompatibleLlmExternalApiResponse
- ElevenlabsExternalApiResponse
Response body for an OpenAI-compatible LLM API configuration.
Was this page helpful?