Developers at Work
Embedded Files
We love developers! Explore resources for developers and API users across OpenAI, including how to get started with custom actions.
Why choose the API?
If your use case requires access outside your ChatGPT workspace, involves handling large amounts of data, or needs to be integrated into another product, the API can provide the flexibility and scalability you need.
External accessibility: Make your use case accessible to end users outside your ChatGPT workspace.
Handling large data: Efficiently manage and process extremely large datasets.
Product integration: Seamlessly integrate ChatGPT into your own products or services.
Custom Actions
Custom Actions empower your GPTs to interact with third-party APIs, enabling tasks like retrieving data, modifying external information, or triggering actions in other systems. Here’s what you need to know to get started.
Key Features
Data Retrieval and Modification: Access and update data from external sources seamlessly.
Action Triggering: Initiate actions in other systems directly from your GPT.
Getting Started with Custom Actions
Step 1: Identify the tasks you want your GPT to perform using third-party APIs.
Step 2: Test your API calls in Postman to ensure they meet the requirements.
Step 3: Integrate the tested APIs with your GPT, adhering to the guidelines above.
Step 4: Monitor and adjust your integrations as needed to maintain optimal performance.
Best Practices
Test before integration
Use Postman: Always test your API schema and calls in Postman before integrating them with your GPT to ensure they work correctly.
If you encounter errors in your schema, ask ChatGPT to help correct them. Simply provide the schema and the error message in your prompt, and ChatGPT can assist you in refining your schema for better results.
Manage External Tools
Limit Integrations: To keep your GPT efficient, limit the number of external tools connected via custom actions within a single GPT.
API Requirements
Response Format: APIs must return text or files. If your API returns links, you’ll need to set up a middleware to handle them.
No Custom Headers: Custom headers are not supported, so ensure your API calls comply with this limitation.
OAuth Domain Matching: For OAuth flows, all domains (except for Google, Microsoft, and Adobe) must match the primary endpoint domain to ensure security and consistency.
Response Size: Keep response payloads under 100,000 characters to maintain performance and reliability.
Timeout Limit: Requests have a 45-second timeout, so make sure your APIs can respond within this timeframe.
Developer Community
Our Developer Community has a wealth of information from OpenAI and your peers!
Build Hour Webinars
Build Hours are a monthly virtual event to empower developers and founders building on our APIs.
They focus on one technical topic per session hosted by a Solutions Architect showcasing core concepts, demos, and customer examples.
Page updated
Report abuse