Skip to main content
POST
Create endpoint connection

Authorizations

​
Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Body

application/json
​
productId
string
required
Example:

"prod_123"

​
name
string
required
Example:

"My API Connection"

​
url
string
required
Example:

"https://api.example.com/v1/chat/completions"

​
httpMethod
enum<string>
required
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
Example:

"POST"

​
authType
enum<string>
required
Available options:
NONE,
BEARER,
API_KEY,
BASIC
Example:

"BEARER"

​
inputTemplate
string | null
required

Jinja2/Nunjucks template for request body. Must contain {{ input.user_message }} placeholder.

Example:

"{\"prompt\": \"{{ input.user_message }}\"}"

​
outputMapping
object | null
required

JSONPath expressions to extract values from API response. Must include "output" key.

Example:
​
id
string
Example:

"ec_123"

​
userId
string | null
Example:

"user_123"

​
hasAuthToken
boolean

Whether an auth token is configured (token value is not exposed)

​
username
string | null

Username for Basic auth

​
hasPassword
boolean

Whether a password is configured (password value is not exposed)

​
headers
object | null
Example:
​
inputSchema
object | null

Optional JSON Schema (draft 2020-12) defining the structure of input fields, their types, and valid values. Must have type "object" with a "properties" key.

Example:
​
type
enum<string>
Available options:
INITIALIZATION,
CONVERSATION,
FINALIZATION
Example:

"CONVERSATION"

​
timeout
integer | null
default:15

Per-attempt request timeout in seconds. Unset applies the default (15). Capped server-side at 120 seconds.

Required range: 1 <= x <= 120
Example:

15

​
rateLimit
integer | null

Maximum requests per minute. Unset (null) means no rate limit.

Required range: x >= 1
Example:

60

​
retryEnabled
boolean
default:true

Whether automatic retry is enabled for failed requests

​
retryMaxAttempts
integer | null
default:1

Maximum number of retry attempts (applied when retryEnabled is true). 0 is only valid when retryEnabled is false; with retry enabled the minimum is 1.

Required range: 0 <= x <= 10
​
retryInitialDelayMs
integer | null
default:1000

Initial delay in milliseconds before first retry

Required range: x >= 0
​
retryBackoffStrategy
enum<string> | null
default:EXPONENTIAL

Strategy for increasing delay between retries

Available options:
FIXED,
EXPONENTIAL,
LINEAR
​
retryMaxDelayMs
integer | null
default:3000

Maximum delay between retry attempts, in milliseconds. Capped server-side at 60000 (60 seconds) to bound retry blast radius.

Required range: 0 <= x <= 60000
​
retryableStatusCodes
integer[]

HTTP status codes that should trigger a retry

Required range: 100 <= x <= 599
​
createdAt
string<date-time>
​
deletedAt
string<date-time> | null

Response

Endpoint connection created successfully

​
productId
string
required
Example:

"prod_123"

​
name
string
required
Example:

"My API Connection"

​
url
string
required
Example:

"https://api.example.com/v1/chat/completions"

​
httpMethod
enum<string>
required
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
Example:

"POST"

​
authType
enum<string>
required
Available options:
NONE,
BEARER,
API_KEY,
BASIC
Example:

"BEARER"

​
inputTemplate
string | null
required

Jinja2/Nunjucks template for request body. Must contain {{ input.user_message }} placeholder.

Example:

"{\"prompt\": \"{{ input.user_message }}\"}"

​
outputMapping
object | null
required

JSONPath expressions to extract values from API response. Must include "output" key.

Example:
​
id
string
Example:

"ec_123"

​
userId
string | null
Example:

"user_123"

​
hasAuthToken
boolean

Whether an auth token is configured (token value is not exposed)

​
username
string | null

Username for Basic auth

​
hasPassword
boolean

Whether a password is configured (password value is not exposed)

​
headers
object | null
Example:
​
inputSchema
object | null

Optional JSON Schema (draft 2020-12) defining the structure of input fields, their types, and valid values. Must have type "object" with a "properties" key.

Example:
​
type
enum<string>
Available options:
INITIALIZATION,
CONVERSATION,
FINALIZATION
Example:

"CONVERSATION"

​
timeout
integer | null
default:15

Per-attempt request timeout in seconds. Unset applies the default (15). Capped server-side at 120 seconds.

Required range: 1 <= x <= 120
Example:

15

​
rateLimit
integer | null

Maximum requests per minute. Unset (null) means no rate limit.

Required range: x >= 1
Example:

60

​
retryEnabled
boolean
default:true

Whether automatic retry is enabled for failed requests

​
retryMaxAttempts
integer | null
default:1

Maximum number of retry attempts (applied when retryEnabled is true). 0 is only valid when retryEnabled is false; with retry enabled the minimum is 1.

Required range: 0 <= x <= 10
​
retryInitialDelayMs
integer | null
default:1000

Initial delay in milliseconds before first retry

Required range: x >= 0
​
retryBackoffStrategy
enum<string> | null
default:EXPONENTIAL

Strategy for increasing delay between retries

Available options:
FIXED,
EXPONENTIAL,
LINEAR
​
retryMaxDelayMs
integer | null
default:3000

Maximum delay between retry attempts, in milliseconds. Capped server-side at 60000 (60 seconds) to bound retry blast radius.

Required range: 0 <= x <= 60000
​
retryableStatusCodes
integer[]

HTTP status codes that should trigger a retry

Required range: 100 <= x <= 599
​
createdAt
string<date-time>
​
deletedAt
string<date-time> | null