# OpenAI

Run OpenAI models and AI features enabled on the agent. Review required fields, credential setup and how this connector works in Zild.

Source: https://zild.ai/en-US/docs/apps/zild-admin/connector-openai

Run OpenAI models and AI features enabled on the agent.

## Where to configure

Open Zild Admin → Integrations → Connectors, find the provider and use Configure or Edit. Enter the data from this guide, enable the connector for the workflow and save.

## Required fields

These requirements are the data needed by the workflow using the connector. Generic saving may accept empty fields that are only required when an operation runs. Saving does not confirm that the provider accepts the credential.



<table class="api-params"><thead><tr><th>Field</th><th>Workflow requirement</th></tr></thead><tbody><tr><td><code>ApiKey</code></td><td>Provider API key.</td></tr></tbody></table>



## How to obtain credentials

- Sign in to the OpenAI API platform and select the integration project.
- In the project API keys area, create a new secret key and copy its value.
- Enter the key in ApiKey and select an available model in the agent configuration.

## How it works in Zild

The agent resolves ConnectorType.OpenAI when configured for OpenAI. ApiKey authenticates access; the model is selected by the agent or the connector default in workflows that use it.

## How to verify the configuration

After saving, use the matching workflow (query, agent, call or processing) to verify access. If it fails, check the credential, permissions and selected provider resource. For limited or legacy types, confirm availability with your administrator before use.

When editing, Zild displays protected credentials as asterisks. Preserve the masked value to keep the current credential or paste a new credential to replace it.

## Official documentation

- [OpenAI: API quickstart](https://developers.openai.com/api/docs/quickstart)

[Back to Connectors](/en-US/docs/apps/zild-admin/integration)