Skip to main content

OpenAI

Vantage integrates with your OpenAI account using the OpenAI Costs API endpoint and an Admin Key.

Prerequisites​

Create a free Vantage account, then follow the steps below to generate an OpenAI Admin Key. Note that you must be an Organization Owner in your OpenAI organization to create an Admin Key.

note

Note that the Costs endpoint is not available to non-admin API keys. At this time, you cannot configure OpenAI Admin Keys to only allow certain permissions. Vantage will never attempt to write to any endpoints using your Admin Key. Vantage only reads from the Costs endpoint of the Usage API.

Create a Connection​

  1. Navigate to the API Keys page of the OpenAI console.
  2. Click + Create new Admin key.
  3. For Name, add an identifiable name, like Vantage Integration.
    Click to view example image
    Create API key modal with a number 1 next to the Create new secret key button and number 2 next to the input field for the key name
  4. Click Create admin key and copy the generated API key.
  5. Navigate to the Connect tab of the OpenAI Settings page in the Vantage console. Then, click Add Admin Key.
  6. The New OpenAI Account modal is displayed. For API key, paste your previously generated Admin Key. For Description, enter any descriptor to identify that you've added this integration, such as your name.
    Click to view example image
    The API key account modal in the Vantage console with sample data added
  7. Click Connect Account.

Costs will be ingested and processed as soon as you add the integration. It usually takes less than 15 minutes to ingest OpenAI costs. As soon as they are processed, they will be available on your All Resources Cost Report. If you decide to remove your OpenAI integration from Vantage, all costs associated with your OpenAI Admin Key will be removed from the Vantage console.

Next Steps: Manage Workspace Access​

Once your costs are imported, select which workspaces this integration is associated with. See the Workspaces documentation for information.

Data Refresh​

See the provider data refresh documentation for information on when data for each provider refreshes in Vantage.

OpenAI Reporting Dimensions​

On OpenAI Cost Reports, you can filter across several dimensions:

  • Organization
  • Operation (e.g., Chat and Completions)
  • Model (e.g., GPT-3.5)