Skip to main content

​
Overview

Pre-built tooling

Pre-built integrations

Access requirements

Setup guide

Useful links

API gotchas

​
Pre-built tooling

ToolsStatus
Pre-built authorization (API Key)✅
Pre-built authorization UI✅
Custom authorization UI✅
End-user authorization guide✅
Expired credentials detection✅
ToolsStatus
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✅
ToolsStatus
HTTP request logging✅
End-to-end type safety✅
Data runtime validation✅
OpenTelemetry export✅
Slack alerts on errors✅
Integration status API✅
ToolsStatus
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 nameDescriptionTypeSource code
create-speechGenerate speech audio from text.Action🔗 Github

​
Batches

Function nameDescriptionTypeSource code
get-batchRetrieve a single batch from OpenAIAction🔗 Github
list-batchesList batches from OpenAIAction🔗 Github

​
Chat

Function nameDescriptionTypeSource code
create-chat-completionCreate a Chat Completions API response for compatibility workflowsAction🔗 Github

​
Embeddings

Function nameDescriptionTypeSource code
create-embeddingCreate embeddings for text inputs.Action🔗 Github

​
Files

Function nameDescriptionTypeSource code
create-fileUpload a file to OpenAI. Must be implemented as a proxy script, not an action, due to multipart/form-data requirements.Action🔗 Github
get-fileRetrieve a single file metadata from OpenAIAction🔗 Github
list-filesList files from OpenAIAction🔗 Github

​
Fine-tuning

Function nameDescriptionTypeSource code
cancel-fine-tuning-jobCancel an OpenAI fine-tuning job.Action🔗 Github
list-fine-tuning-jobsList fine-tuning jobs from OpenAIAction🔗 Github

​
Images

Function nameDescriptionTypeSource code
create-imageGenerate an image from a prompt.Action🔗 Github

​
Models

Function nameDescriptionTypeSource code
get-modelRetrieve a single model from OpenAI.Action🔗 Github
list-modelsList all models available to the authenticated organizationAction🔗 Github

​
Moderations

Function nameDescriptionTypeSource code
create-moderationClassify whether text or images violate OpenAI usage policiesAction🔗 Github

​
Responses

Function nameDescriptionTypeSource code
create-responseCreate a model response with text, image, file, or tool inputsAction🔗 Github
delete-responseDelete a stored OpenAI responseAction🔗 Github
get-responseRetrieve a stored OpenAI response by ID.Action🔗 Github

​
Vector Stores

Function nameDescriptionTypeSource code
add-vector-store-fileAttach a file to a vector store for indexingAction🔗 Github
create-vector-storeCreate a vector store in OpenAIAction🔗 Github
delete-vector-storeDelete a vector store from OpenAIAction🔗 Github
get-vector-store-fileRetrieve a single file attached to a vector store.Action🔗 Github
get-vector-storeRetrieve a single vector store from OpenAIAction🔗 Github
list-vector-store-filesList files attached to a vector storeAction🔗 Github
update-vector-storeUpdate a vector store in OpenAIAction🔗 Github

​
Others

Function nameDescriptionTypeSource code
create-batchCreate a batch in OpenAIAction🔗 Github
create-transcriptionTranscribe audio to text. Use proxy script openai/proxy/transcribe-audio.ts for actual file uploads.Action🔗 Github
delete-vector-store-fileRemove a file from a vector store (does not delete the underlying file object)Action🔗 Github
list-vector-storesList vector stores from OpenAI.Action🔗 Github
search-vector-storeSearch a vector store for semantically matching content chunksAction🔗 Github
batchesSync batches from OpenAISync🔗 Github
filesSync files from OpenAI.Sync🔗 Github
fine-tuning-jobsSync fine-tuning jobs from OpenAISync🔗 Github
modelsSync models from OpenAI.Sync🔗 Github
vector-storesSync vector stores from OpenAISync🔗 Github

​
Access requirements

Pre-RequisitesStatusComment
Paid dev account❓
Paid test account❓
Partnership❓
App review❓
Security audit❓

​
Setup guide

No setup guide yet.
Need help getting started? Get help in the community.
Contribute improvements to the setup guide by editing this page
Contribute useful links by editing this page

​
API gotchas

  • 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.
  • For users associated with multiple organizations or accessing their projects via a legacy user API key, optional headers can be included to specify the organization and project for the API request. Organization IDs can be found on your Organization settings page, while project IDs can be found on your General settings page.
  • This can be done at the script level:
const config:ProxyConfiguration = {
    endpoint: '/v1/models',
    headers: {
        'OpenAI-Organization': $organizationId,
        'OpenAI-Project': $projectId
    }
};
Contribute API gotchas by editing this page

​
Going further

Connect to Openai

Guide to connect to Openai using Nango Connect.