Overview
Pre-built tooling
Pre-built integrations
Access requirements
Setup guide
Useful links
API gotchas
Pre-built tooling
β
Authorization
β Authorization
β
Read & write data
β 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 | β |
β
Observability & data quality
β 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 | β |
β
Customization
β 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 | β |
Audio
| Function name | Description | Type | Source code |
|---|---|---|---|
create-speech | Generate speech audio from text. | Action | π Github |
Batches
| Function name | Description | Type | Source code |
|---|---|---|---|
get-batch | Retrieve a single batch from OpenAI | Action | π Github |
list-batches | List batches from OpenAI | Action | π Github |
Chat
| Function name | Description | Type | Source code |
|---|---|---|---|
create-chat-completion | Create a Chat Completions API response for compatibility workflows | Action | π Github |
Embeddings
| Function name | Description | Type | Source code |
|---|---|---|---|
create-embedding | Create embeddings for text inputs. | Action | π Github |
Files
| Function name | Description | Type | Source code |
|---|---|---|---|
create-file | Upload a file to OpenAI. Must be implemented as a proxy script, not an action, due to multipart/form-data requirements. | Action | π Github |
get-file | Retrieve a single file metadata from OpenAI | Action | π Github |
list-files | List files from OpenAI | Action | π Github |
Fine-tuning
| Function name | Description | Type | Source code |
|---|---|---|---|
cancel-fine-tuning-job | Cancel an OpenAI fine-tuning job. | Action | π Github |
list-fine-tuning-jobs | List fine-tuning jobs from OpenAI | Action | π Github |
Images
| Function name | Description | Type | Source code |
|---|---|---|---|
create-image | Generate an image from a prompt. | Action | π Github |
Models
| Function name | Description | Type | Source code |
|---|---|---|---|
get-model | Retrieve a single model from OpenAI. | Action | π Github |
list-models | List all models available to the authenticated organization | Action | π Github |
Moderations
| Function name | Description | Type | Source code |
|---|---|---|---|
create-moderation | Classify whether text or images violate OpenAI usage policies | Action | π Github |
Responses
| Function name | Description | Type | Source code |
|---|---|---|---|
create-response | Create a model response with text, image, file, or tool inputs | Action | π Github |
delete-response | Delete a stored OpenAI response | Action | π Github |
get-response | Retrieve a stored OpenAI response by ID. | Action | π Github |
Vector Stores
| Function name | Description | Type | Source code |
|---|---|---|---|
add-vector-store-file | Attach a file to a vector store for indexing | Action | π Github |
create-vector-store | Create a vector store in OpenAI | Action | π Github |
delete-vector-store | Delete a vector store from OpenAI | Action | π Github |
get-vector-store-file | Retrieve a single file attached to a vector store. | Action | π Github |
get-vector-store | Retrieve a single vector store from OpenAI | Action | π Github |
list-vector-store-files | List files attached to a vector store | Action | π Github |
update-vector-store | Update a vector store in OpenAI | Action | π Github |
Others
| Function name | Description | Type | Source code |
|---|---|---|---|
create-batch | Create a batch in OpenAI | Action | π Github |
create-transcription | Transcribe audio to text. Use proxy script openai/proxy/transcribe-audio.ts for actual file uploads. | Action | π Github |
delete-vector-store-file | Remove a file from a vector store (does not delete the underlying file object) | Action | π Github |
list-vector-stores | List vector stores from OpenAI. | Action | π Github |
search-vector-store | Search a vector store for semantically matching content chunks | Action | π Github |
batches | Sync batches from OpenAI | Sync | π Github |
files | Sync files from OpenAI. | Sync | π Github |
fine-tuning-jobs | Sync fine-tuning jobs from OpenAI | Sync | π Github |
models | Sync models from OpenAI. | Sync | π Github |
vector-stores | Sync vector stores from OpenAI | Sync | π Github |
Access requirements
| Pre-Requisites | Status | Comment |
|---|---|---|
| Paid dev account | β | |
| Paid test account | β | |
| Partnership | β | |
| App review | β | |
| Security audit | β |
Setup guide
No setup guide yet.Contribute improvements to the setup guide by editing this page
Useful links
- Generate an Admin key in your OpenAI account
- OpenAI API docs
- OpenAI Authentication
- OpenAI rate limits
Contribute useful links by editing this page
API gotchas
- Admin API keys cannot be used for non-administration endpoints.
- OpenAI uses API_KEY auth mode with
Authorization: Bearer API_KEYin the request header to access different endpoints. - Nango supports automatic retries based on the
x-ratelimit-reset-requestsheader from OpenAIβs API. This header indicates when the request limit will reset, allowing Nango to efficiently manage API calls. Unlikex-ratelimit-reset-tokens, which pertains to the total token usage,x-ratelimit-reset-requestsspecifically addresses the number of API requests.
Contribute API gotchas by editing this page
Going further
Connect to Openai Administration
Guide to connect to Openai with Admin Keys using Nango Connect.