Skip to main content
POST
Create OpenAI integration

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

write

Grants write access

Body

application/json

Create an OpenAI Integration

api_key
string
required

OpenAI Admin API key (sk-admin-...). With codex_analytics, an Analytics API key for the ChatGPT workspace.

description
string
required

Name for this OpenAI integration in Vantage.

codex_analytics
boolean
default:false

When true, creates an OpenAI Codex Analytics integration for a ChatGPT workspace instead of an OpenAI API usage integration.

workspace_id
string

ChatGPT workspace UUID from the ChatGPT Admin console. Required when codex_analytics is true.

Response

Integration model

token
string
required
provider
string
required

The name of the Integration.

Example:

"AWS"

account_identifier
string | null
required

The account identifier. For GCP this is the billing Account ID, for Azure this is the account ID

Example:

"011389-EF4C3E-3ED7AE"

status
enum<string>
required

The status of the Integration. Can be 'connected', 'error', 'pending', 'importing', 'imported', or 'disconnected'.

Available options:
connected,
error,
pending,
importing,
imported,
disconnected
Example:

"imported"

workspace_tokens
string[]
required

The tokens for any Workspaces that the account belongs to.

created_at
string
required

The date and time, in UTC, the Integration was created. ISO 8601 Formatted.

Example:

"2023-08-04T00:00:00Z"

managed_account_tokens
string[]
required

The tokens for any Managed Accounts that are associated with the Integration.

enriched_by
string[]
required

Tokens of the data integrations that enrich this integration's costs. Empty when enrichment is not connected.

last_updated
string | null

The date and time, in UTC, when the Integration was last updated. ISO 8601 Formatted.

Example:

"2023-08-04T00:00:00Z"