User Guide/Integrations
Integrations

How to Add an OpenAI API Key

Create and add the OpenAI API key Cortex currently uses for OpenAI-backed model access.

What This Credential Is For

Use this credential when Cortex needs to call OpenAI-backed models on your behalf.

Current Scope

Cortex currently supports adding an OpenAI API key. This guide is not about configuring an arbitrary model endpoint or bringing your own model routing layer.

What To Create In OpenAI

Create an API key in your OpenAI account before adding the credential in Cortex.

How To Add It In Cortex

  1. Create the API key in OpenAI.
  2. Open the relevant credential-management surface in Cortex.
  3. Add the key as an organization-scoped OpenAI credential.
  4. Use that credential anywhere Cortex expects OpenAI-backed model access.

How Cortex Uses It

Cortex should use this credential when making outbound requests to supported OpenAI-backed model services. In most cases, you should not need to recreate it for each project.

Handle Secrets Carefully

Store the API key in Cortex rather than passing it around in ad hoc configuration. Rotate it in the provider and update Cortex if you believe it has been exposed.