Skip to main content
POST
cURL
Check out the configuration docs for OpenAI Connections to learn how to obtain the required credentials.
Creates an OpenAI app connection using an Admin API key. The connection can then be used for OpenAI Service Account secret rotations.

Request body

Sample request

Sample response

Body

application/json
method
enum<string>
required

The method used to authenticate with OpenAI.

Available options:
api-key
credentials
object
required

The credentials used to connect with OpenAI.

name
string
required

The name of the OpenAI Connection to create. Must be slug-friendly.

Required string length: 1 - 64
description
string | null

An optional description for the OpenAI Connection.

Maximum string length: 256
projectId
string

The ID of the project to create the OpenAI Connection in.

isPlatformManagedCredentials
enum<boolean>

Not supported for OpenAI Connections.

Available options:
false
gatewayId

Not supported for OpenAI Connections.

gatewayPoolId

Not supported for OpenAI Connections.

isAutoRotationEnabled
enum<boolean>

Not supported for OpenAI Connections.

Available options:
false
rotation

Not supported for OpenAI Connections.

Response

Default Response

appConnection
OpenAI (API Key) · object
required