Skip to main content
POST
/
v1
/
external-apis
Create External API Configuration
curl --request POST \
  --url https://api.example.com/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"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "type": "openai_compatible_llm"
}

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
​
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.

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