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

  • 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.
Contribute API gotchas by editing this page

Going further

Connect to Openai Administration

Guide to connect to Openai with Admin Keys using Nango Connect.