OpenAI

OpenAI is a leading artificial intelligence research and deployment company that provides access to advanced large language models (LLMs) and AI capabilities through their API platform. This integration enables users to query, monitor, and manage their OpenAI resources, including AI models, completions, text generation requests, chat interactions, and API usage.

Category	AI & ML
Direction	Query source
Sign-in	API Key
Query languages	SQLite
Tables	3
Query templates	6
Website	openai.com

Before you start

Huntbase signs in to OpenAI with API Key. Create the credential in OpenAI first, then keep it to hand for the Connect step.

1. In the OpenAI platform dashboard, open the API keys page in your organization settings (platform.openai.com/settings/organization/api-keys).
2. Create a secret key and copy it.

Watch out for

• A key has the same permissions as the user who created it, and changes if that user's permissions change.
• Keep the key secret. Don't paste it into shared notes or client-side code.

For the vendor's own instructions, see OpenAI API authentication.

tip

Use a dedicated, read-only credential for Huntbase where the product allows it. Huntbase only needs to read.

Connect OpenAI

1. Go to Connections and click New connection, or click New connection on the OpenAI product page.
2. On Product, pick OpenAI and choose the Owner.
3. On Details, give the connection a Name and, optionally, a Description.
4. On Connect, fill in the settings and credentials described below.
5. On Verify, review the summary and click Create & check.

For everything else on the setup page — saving a draft, I'll do this later, and what each check result means — see Connections.

Credentials

The only Method is API Key. Enter a Credential label (for example Production), then fill in:

Field	Required	Notes
API Key	Yes	Secret — not shown again after you save it.

Query it

Once connected, OpenAI can serve these languages in a query tab, and Scout can use it when you ask in Auto:

Language	Use it for
SQLite	SQL over the 3 tables listed below, alongside every other connected source.

Example: SQLite

List OpenAI models — Retrieve the IDs of all models available in the OpenAI environment.

SELECT
  id
FROM
  openai_model;

OpenAI ships with 6 query templates. Find them in Library › Queries — see Query templates.

Tables

OpenAI adds 3 tables. Browse their columns from Schema in the query bar's ⋯ menu.

All 3 tables

Table	Contains
openai_completion	Completions available in OpenAI.
openai_file	Files uploaded to OpenAI for fine-tuning.
openai_model	Models available in OpenAI.

Next steps

• Connections — health, credentials and settings after you connect
• Query languages — syntax, parameters and time ranges
• Chatting with Scout — ask questions without writing a query
• All integrations — the rest of the catalog