> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAI Administration

## Overview

> [card] [Pre-built tooling](#pre-built-tooling)

> [card] [Pre-built integrations](#pre-built-integrations)

> [card] [Access requirements](#access-requirements)

> [card] [Setup guide](#setup-guide)

> [card] [Useful links](#useful-links)

> [card] [API gotchas](#api-gotchas)

## Pre-built tooling

> [accordion] ✅ Authorization
>
> | Tools | Status |
> | - | - |
> | Pre-built authorization (API Key) | ✅ |
> | Pre-built authorization UI | ✅ |
> | Custom authorization UI | ✅ |
> | End-user authorization guide | ✅ |
> | Expired credentials detection | ✅ |

> [accordion] ✅ Read & write data
>
> | Tools | Status |
> | - | - |
> | Pre-built integrations | ✅ |
> | API unification | ✅ |
> | 2-way sync | ✅ |
> | Webhooks from Nango on data modifications | ✅ |
> | Real-time webhooks from 3rd-party API | 🚫 (time to contribute: \<48h) |
> | Proxy requests | ✅ |

> [accordion] ✅ Observability & data quality
>
> | Tools | Status |
> | - | - |
> | HTTP request logging | ✅ |
> | End-to-end type safety | ✅ |
> | Data runtime validation | ✅ |
> | OpenTelemetry export | ✅ |
> | Slack alerts on errors | ✅ |
> | Integration status API | ✅ |

> [accordion] ✅ Customization
>
> | Tools | Status |
> | - | - |
> | Create or customize use-cases | ✅ |
> | Pre-configured pagination | 🚫 (time to contribute: \<48h) |
> | Pre-configured rate-limit handling | 🚫 (time to contribute: \<48h) |
> | Per-customer configurations | ✅ |

### Others

| Function name | Description | Type |
| - | - | - |
| `add-vector-store-file` | Attach a file to a vector store for indexing | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `cancel-fine-tuning-job` | Cancel an OpenAI fine-tuning job. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-batch` | Create a batch in OpenAI | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-chat-completion` | Create a Chat Completions API response for compatibility workflows | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-embedding` | Create embeddings for text inputs. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-file` | Upload a file to OpenAI. Must be implemented as a proxy script, not an action, due to multipart/form-data requirements. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-image` | Generate an image from a prompt. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-moderation` | Classify whether text or images violate OpenAI usage policies | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-response` | Create a model response with text, image, file, or tool inputs | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-speech` | Generate speech audio from text. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-transcription` | Transcribe audio to text. Use proxy script openai/proxy/transcribe-audio.ts for actual file uploads. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-vector-store` | Create a vector store in OpenAI | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-response` | Delete a stored OpenAI response | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-vector-store-file` | Remove a file from a vector store (does not delete the underlying file object) | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-vector-store` | Delete a vector store from OpenAI | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-batch` | Retrieve a single batch from OpenAI | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-file` | Retrieve a single file metadata from OpenAI | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-model` | Retrieve a single model from OpenAI. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-response` | Retrieve a stored OpenAI response by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-vector-store-file` | Retrieve a single file attached to a vector store. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-vector-store` | Retrieve a single vector store from OpenAI | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-batches` | List batches from OpenAI | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-files` | List files from OpenAI | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-fine-tuning-jobs` | List fine-tuning jobs from OpenAI | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-models` | List all models available to the authenticated organization | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-vector-store-files` | List files attached to a vector store | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-vector-stores` | List vector stores from OpenAI. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `search-vector-store` | Search a vector store for semantically matching content chunks | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-vector-store` | Update a vector store in OpenAI | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `batches` | Sync batches from OpenAI | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `files` | Sync files from OpenAI. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `fine-tuning-jobs` | Sync fine-tuning jobs from OpenAI | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `models` | Sync models from OpenAI. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `vector-stores` | Sync vector stores from OpenAI | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

## Access requirements

| Pre-Requisites | Status | Comment |
| - | - | - |
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ | |

## Setup guide

*No setup guide yet.*

> [!TIP]
>
> Need help getting started? Get help in the [community](https://nango.dev/slack).

> [!NOTE]
>
> Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/openai.mdx)

## Useful links

* [Generate an Admin key in your OpenAI account](https://platform.openai.com/settings/organization/admin-keys)
* [OpenAI API docs](https://platform.openai.com/docs/api-reference/administration)
* [OpenAI Authentication](https://platform.openai.com/docs/api-reference/authentication)
* [OpenAI rate limits](https://platform.openai.com/docs/guides/rate-limits)

> [!NOTE]
>
> Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/openai-admin.mdx)

## API gotchas

* Admin API keys cannot be used for non-administration endpoints.
* OpenAI uses API\_KEY auth mode with `Authorization: Bearer API_KEY` in the request header to access different endpoints.
* Nango supports automatic retries based on the `x-ratelimit-reset-requests` header from OpenAI's API. This header indicates when the request limit will reset, allowing Nango to efficiently manage API calls. Unlike `x-ratelimit-reset-tokens`, which pertains to the total token usage,`x-ratelimit-reset-requests` specifically addresses the number of API requests.

> [!NOTE]
>
> Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/openai-admin.mdx)

## Going further

> [card] [Connect to Openai Administration](https://nango.dev/docs/integrations/all/openai-admin/connect)
>
> Guide to connect to Openai with Admin Keys using Nango Connect.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.