openai · OpenAI Platform Docs
GPT Actions
Comprehensive guidance on implementing GPT Actions, covering initial setup, OpenAPI schema development, authentication methods including OAuth and API keys, and advanced data handling such as retrieving information fr...
Derived skill
Files assembled from official documentation
Viewing SKILL.md
GPT Actions
Comprehensive guidance on implementing GPT Actions, covering initial setup, OpenAPI schema development, authentication methods including OAuth and API keys, and advanced data handling such as retrieving information fr...
When To Use
Use when you need to design, authenticate, or debug GPT Actions, specifically for tasks like connecting to external APIs, implementing OAuth, retrieving data from databases, or configuring file uploads and downloads.
Reference Files
| File | Contains | Use For |
|---|---|---|
SKILL.md | Entry point: scope, routing table, and workflow. | Start here. |
docs/gpt-actions-library-api-docs/workflow-guide.md | An overview of the GPT Actions library including purpose, setup requirements, and access methods. | Questions about an overview of the GPT Actions library including purpose, setup requirements, and access methods. |
docs/gpt-actions-library-api-docs-md/workflow-guide.md | An overview of the GPT Actions library including purpose, setup requirements, and access instructions. | Questions about an overview of the GPT Actions library including purpose, setup requirements, and access instructions. |
docs/gpt-action-authentication-openai-api-docs-actions/workflow-guide.md | A guide detailing the different authentication schemas available for GPT Actions, including None, API Key, and OAuth. | Questions about a guide detailing the different authentication schemas available for GPT Actions, including None, API Key, and OAuth. |
docs/gpt-action-authentication-api-docs-actions-md/workflow-guide.md | A guide explaining the different authentication schemas available for GPT Actions, including None, API Key, and OAuth. | Questions about a guide explaining the different authentication schemas available for GPT Actions, including None, API Key, and OAuth. |
docs/data-retrieval-with-gpt-actions-api-docs/workflow-guide.md | This documentation outlines methods for GPT actions to retrieve data via APIs, relational databases, and vector databases. | Questions about this documentation outlines methods for GPT actions to retrieve data via APIs, relational databases, and vector datab... |
docs/data-retrieval-with-gpt-actions-api-docs-md/workflow-guide.md | A guide explaining how GPT actions can retrieve data using APIs, relational databases, and vector databases. | Questions about a guide explaining how GPT actions can retrieve data using APIs, relational databases, and vector databases. |
docs/getting-started-with-gpt-actions-api-docs/workflow-guide.md | A guide outlining the steps to create and test GPT Actions using an OpenAPI schema and authentication requirements, featuring a Weather.gov example. | Questions about a guide outlining the steps to create and test GPT Actions using an OpenAPI schema and authentication requirements, f... |
examples/getting-started-with-gpt-actions-api-docs/openai-gpt-actions-openapi-specification.text | An OpenAPI 3.1 specification defining the schema and endpoints required to configure a GPT Action. | Exact payloads, commands, or snippets shown in An OpenAPI 3.1 specification defining the schema and endpoints required to configure a GPT Action. |
examples/getting-started-with-gpt-actions-api-docs/openai-gpt-actions-nws-weather-api-openapi-spec.text | An OpenAPI specification for the NWS Weather API used to demonstrate configuring GPT Actions. | Exact payloads, commands, or snippets shown in An OpenAPI specification for the NWS Weather API used to demonstrate configuring GPT Actions. |
examples/getting-started-with-gpt-actions-api-docs/openai-gpt-actions-openapi-specification-2.text | An OpenAPI specification snippet defining a weather forecast endpoint for use with GPT Actions. | Exact payloads, commands, or snippets shown in An OpenAPI specification snippet defining a weather forecast endpoint for use with GPT Actions. |
examples/getting-started-with-gpt-actions-api-docs/gpt-actions-weather-forecast-prompt-instructions.text | A text-based prompt instruction set for a GPT action designed to handle weather forecast requests based on user location input. | Exact payloads, commands, or snippets shown in A text-based prompt instruction set for a GPT action designed to handle weather forecast requests based on user locat... |
docs/getting-started-with-gpt-actions-api-docs-md/workflow-guide.md | A guide explaining how to create and test GPT Actions using an OpenAPI schema and authentication requirements, featuring a Weather.gov example. | Questions about a guide explaining how to create and test GPT Actions using an OpenAPI schema and authentication requirements, featur... |
schemas/getting-started-with-gpt-actions-api-docs-md/openai-gpt-actions-openapi.yaml | An OpenAPI 3.1.0 specification schema for the NWS Weather API used to demonstrate GPT Actions configuration. | Exact field names, object shape, and structured values described in An OpenAPI 3.1.0 specification schema for the NWS Weather API used to demonstrate GPT Actions configuration. |
examples/getting-started-with-gpt-actions-api-docs-md/openai-gpt-actions-openapi-specification.yaml | An OpenAPI specification file defining the NWS Weather API structure for use with GPT Actions. | Exact payloads, commands, or snippets shown in An OpenAPI specification file defining the NWS Weather API structure for use with GPT Actions. |
examples/getting-started-with-gpt-actions-api-docs-md/openai-gpt-actions-openapi-specification-2.yaml | A YAML OpenAPI specification defining a weather forecast endpoint for use with GPT Actions. | Exact payloads, commands, or snippets shown in A YAML OpenAPI specification defining a weather forecast endpoint for use with GPT Actions. |
examples/getting-started-with-gpt-actions-api-docs-md/gpt-actions-weather-forecast-prompt-instructions.text | A text-based prompt instruction set for a GPT action designed to handle weather forecast requests based on user location input. | Exact payloads, commands, or snippets shown in A text-based prompt instruction set for a GPT action designed to handle weather forecast requests based on user locat... |
docs/sending-and-returning-files-with-gpt-actions-api-docs-getting-started-in/workflow-guide.md | A guide explaining how to include files in POST requests and handle file URLs when using GPT Actions. | Questions about a guide explaining how to include files in POST requests and handle file URLs when using GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started-in/openai-gpt-actions-object-json.text | A JSON representation of a file object containing name, id, mimetype, and download link used in GPT Actions. | Exact payloads, commands, or snippets shown in A JSON representation of a file object containing name, id, mimetype, and download link used in GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started-in/openai-gpt-actions-createwidget-openapi-spec.text | An OpenAPI specification defining the createWidget operation for uploading file references via GPT Actions. | Exact payloads, commands, or snippets shown in An OpenAPI specification defining the createWidget operation for uploading file references via GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started-in/openai-gpt-actions-payload-examples.text | A text file containing JSON-formatted examples of file objects including name, mimetype, and base64 content for PDF and CSV files used in GPT Actions. | Exact payloads, commands, or snippets shown in A text file containing JSON-formatted examples of file objects including name, mimetype, and base64 content for PDF a... |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started-in/openai-gpt-actions-findpapers-openapi-specification.text | An OpenAPI specification defining the findPapers operation for retrieving academic paper PDFs via GPT Actions. | Exact payloads, commands, or snippets shown in An OpenAPI specification defining the findPapers operation for retrieving academic paper PDFs via GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started-in/gpt-actions-url-list.text | A list of example file URLs used to demonstrate sending and returning files within GPT Actions. | Exact payloads, commands, or snippets shown in A list of example file URLs used to demonstrate sending and returning files within GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started-in/gpt-actions-transfer-http-headers.text | An example of the HTTP headers required to send and return files using GPT Actions. | Exact payloads, commands, or snippets shown in An example of the HTTP headers required to send and return files using GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started-in/openai-gpt-actions-openapi-spec-findpapers.text | An OpenAPI specification defining the findPapers operation for retrieving academic paper PDFs via GPT Actions. | Exact payloads, commands, or snippets shown in An OpenAPI specification defining the findPapers operation for retrieving academic paper PDFs via GPT Actions. |
docs/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/workflow-guide.md | A guide explaining how to include file URLs in POST requests and how to return files within GPT Actions. | Questions about a guide explaining how to include file URLs in POST requests and how to return files within GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/openai-gpt-actions-returning-files-json-response.text | A JSON array representing the file object structure returned by a GPT Action, including name, id, mimetype, and download link. | Exact payloads, commands, or snippets shown in A JSON array representing the file object structure returned by a GPT Action, including name, id, mimetype, and downl... |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/openai-gpt-actions-createwidget-openapi-specification.text | An OpenAPI specification defining the createWidget operation for sending and returning files via GPT Actions. | Exact payloads, commands, or snippets shown in An OpenAPI specification defining the createWidget operation for sending and returning files via GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/gpt-actions-returning-files-json-payload.text | A JSON array containing example file metadata including names, mimetypes, and base64 encoded content for PDF and CSV files. | Exact payloads, commands, or snippets shown in A JSON array containing example file metadata including names, mimetypes, and base64 encoded content for PDF and CSV... |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/openai-gpt-actions-returning-files-openapi-spec.text | An OpenAPI specification defining a findPapers operation that returns academic paper PDFs via GPT Actions. | Exact payloads, commands, or snippets shown in An OpenAPI specification defining a findPapers operation that returns academic paper PDFs via GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/gpt-actions-returning-files-url-list.text | A list of example file URLs returned by a GPT Action to demonstrate the file transfer protocol. | Exact payloads, commands, or snippets shown in A list of example file URLs returned by a GPT Action to demonstrate the file transfer protocol. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/gpt-actions-returning-files-http-response-header.text | An example of the HTTP response headers required to return a file attachment via GPT Actions. | Exact payloads, commands, or snippets shown in An example of the HTTP response headers required to return a file attachment via GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/openai-gpt-actions-openapi-spec-returning-files.text | An OpenAPI specification defining the findPapers operation for retrieving academic papers as PDF files via GPT Actions. | Exact payloads, commands, or snippets shown in An OpenAPI specification defining the findPapers operation for retrieving academic papers as PDF files via GPT Actions. |
docs/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/workflow-guide.md | A guide explaining how to include file URLs in POST requests and handle file transfers within GPT Actions. | Questions about a guide explaining how to include file URLs in POST requests and handle file transfers within GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/openai-gpt-actions-object-json.text | A JSON array representing file objects containing names, IDs, and download links used when sending and returning files with GPT Actions. | Exact payloads, commands, or snippets shown in A JSON array representing file objects containing names, IDs, and download links used when sending and returning file... |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/gpt-actions-createwidget-openapi-specification.text | An OpenAPI specification defining the createWidget operation for uploading file references via GPT Actions. | Exact payloads, commands, or snippets shown in An OpenAPI specification defining the createWidget operation for uploading file references via GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/gpt-actions-payload-json.text | A JSON array containing sample file metadata including names, mimetypes, and base64 encoded content for testing GPT Actions. | Exact payloads, commands, or snippets shown in A JSON array containing sample file metadata including names, mimetypes, and base64 encoded content for testing GPT A... |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/openai-gpt-actions-findpapers-openapi-specification.text | An OpenAPI specification defining the findPapers operation to retrieve academic paper PDFs via GPT Actions. | Exact payloads, commands, or snippets shown in An OpenAPI specification defining the findPapers operation to retrieve academic paper PDFs via GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/gpt-actions-url-response-list.text | A list of example file URLs returned by a GPT Action response. | Exact payloads, commands, or snippets shown in A list of example file URLs returned by a GPT Action response. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/gpt-actions-sending-files-http-response.text | An example of an HTTP response header configuration for sending a PDF file attachment via GPT Actions. | Exact payloads, commands, or snippets shown in An example of an HTTP response header configuration for sending a PDF file attachment via GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-getting-started/openai-gpt-actions-openapi-spec-findpapers.text | An OpenAPI specification defining the findPapers operation for retrieving academic paper PDFs via GPT Actions. | Exact payloads, commands, or snippets shown in An OpenAPI specification defining the findPapers operation for retrieving academic paper PDFs via GPT Actions. |
docs/gpt-actions-api-docs-introduction/workflow-guide.md | An overview of how GPT Actions work within Custom GPTs to connect ChatGPT to third-party services. | Questions about an overview of how GPT Actions work within Custom GPTs to connect ChatGPT to third-party services. |
examples/gpt-actions-api-docs-introduction/gpt-actions-openapi-specification.text | A sample OpenAPI specification file used to define custom actions for GPTs. | Exact payloads, commands, or snippets shown in A sample OpenAPI specification file used to define custom actions for GPTs. |
examples/gpt-actions-api-docs-introduction/gpt-actions-openapi-specification-2.text | A sample OpenAPI specification file used to define custom actions for GPTs. | Exact payloads, commands, or snippets shown in A sample OpenAPI specification file used to define custom actions for GPTs. |
docs/gpt-actions-api-docs-introduction-md/workflow-guide.md | An introduction to how GPT Actions work within Custom GPTs to connect ChatGPT to third-party services. | Questions about an introduction to how GPT Actions work within Custom GPTs to connect ChatGPT to third-party services. |
examples/gpt-actions-api-docs-introduction-md/gpt-actions-openapi-specification.json | A sample JSON OpenAPI specification used to define custom actions for GPTs. | Exact payloads, commands, or snippets shown in A sample JSON OpenAPI specification used to define custom actions for GPTs. |
examples/gpt-actions-api-docs-introduction-md/gpt-actions-openapi-specification-2.json | A sample OpenAPI specification file used to define custom actions for GPTs. | Exact payloads, commands, or snippets shown in A sample OpenAPI specification file used to define custom actions for GPTs. |
docs/production-notes-on-gpt-actions-api-docs-md/workflow-guide.md | Technical guidelines for deploying GPT Actions including rate limiting, timeouts, security protocols, and IP egress ranges. | Questions about technical guidelines for deploying GPT Actions including rate limiting, timeouts, security protocols, and IP egress r... |
examples/production-notes-on-gpt-actions-api-docs-md/openai-gpt-actions-production-notes-openapi-spec.yaml | A YAML representation of an OpenAPI specification demonstrating the use of the x-openai-is-consequential flag for GPT Actions. | Exact payloads, commands, or snippets shown in A YAML representation of an OpenAPI specification demonstrating the use of the x-openai-is-consequential flag for GPT... |
docs/sending-and-returning-files-with-gpt-actions-api-docs-md/workflow-guide.md | A guide explaining how to include file URLs in POST requests and handle file transfers within GPT Actions. | Questions about a guide explaining how to include file URLs in POST requests and handle file transfers within GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-md/openai-gpt-actions-response.json | A JSON object representing a file response structure containing file metadata and download links used in GPT Actions. | Exact payloads, commands, or snippets shown in A JSON object representing a file response structure containing file metadata and download links used in GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-md/gpt-actions-createwidget-yaml-spec.yaml | A YAML specification defining the createWidget operation for sending file references via GPT Actions. | Exact payloads, commands, or snippets shown in A YAML specification defining the createWidget operation for sending file references via GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-md/gpt-actions-transfer-payload.json | A JSON object containing example file metadata and base64 encoded content for sending and returning files via GPT Actions. | Exact payloads, commands, or snippets shown in A JSON object containing example file metadata and base64 encoded content for sending and returning files via GPT Act... |
examples/sending-and-returning-files-with-gpt-actions-api-docs-md/gpt-actions-sending-returning-files-openapi-specification.yaml | An OpenAPI specification defining an action to retrieve academic papers as PDF files in response to a topic query. | Exact payloads, commands, or snippets shown in An OpenAPI specification defining an action to retrieve academic papers as PDF files in response to a topic query. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-md/openai-gpt-actions-url-response.json | A JSON array containing example file URLs used to demonstrate how GPT Actions return files to a user. | Exact payloads, commands, or snippets shown in A JSON array containing example file URLs used to demonstrate how GPT Actions return files to a user. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-md/openai-gpt-actions-transfer-http-headers.text | An example of the HTTP headers required to send and return files using GPT Actions. | Exact payloads, commands, or snippets shown in An example of the HTTP headers required to send and return files using GPT Actions. |
examples/sending-and-returning-files-with-gpt-actions-api-docs-md/gpt-actions-sending-returning-files-openapi-specification-2.yaml | An OpenAPI specification defining an action to retrieve academic papers as PDF files in response to a topic query. | Exact payloads, commands, or snippets shown in An OpenAPI specification defining an action to retrieve academic papers as PDF files in response to a topic query. |
What This Skill Covers
- GPT Actions library: While GPT Actions should be significantly less work for an API developer to set up than an entire application using those APIs from scratch, there’s still so...
- GPT Actions library: While GPT Actions should be significantly less work for an API developer to set up than an entire application using those APIs from scratch, there’s still so...
- GPT Action authentication | OpenAI API: Actions offer different authentication schemas to accommodate various use cases. To specify the authentication schema for your action, use the GPT editor and...
- GPT Action authentication: Actions offer different authentication schemas to accommodate various use cases. To specify the authentication schema for your action, use the GPT editor and...
- Data retrieval with GPT Actions: One of the most common tasks an action in a GPT can perform is data retrieval. An action might:
- Data retrieval with GPT Actions: One of the most common tasks an action in a GPT can perform is data retrieval. An action might:
- Getting started with GPT Actions: The NSW (National Weather Service) maintains a public API that users can query to receive a weather forecast for any lat-long point. To retrieve a forecast,...
- Getting started with GPT Actions: The NSW (National Weather Service) maintains a public API that users can query to receive a weather forecast for any lat-long point. To retrieve a forecast,...
- Sending and returning files with GPT Actions: POST requests can include up to ten files (including DALL-E generated images) from the conversation. They will be sent as URLs which are valid for five minutes.
- Sending and returning files with GPT Actions: POST requests can include up to ten files (including DALL-E generated images) from the conversation. They will be sent as URLs which are valid for five minutes.
- Sending and returning files with GPT Actions: POST requests can include up to ten files (including DALL-E generated images) from the conversation. They will be sent as URLs which are valid for five minutes.
- GPT Actions: GPT Actions are stored in Custom GPTs, which enable users to customize ChatGPT for specific use cases by providing instructions, attaching documents as knowl...
- GPT Actions: GPT Actions are stored in Custom GPTs, which enable users to customize ChatGPT for specific use cases by providing instructions, attaching documents as knowl...
- Production notes on GPT Actions: Consider implementing rate limiting on the API endpoints you expose. ChatGPT will respect 429 response codes and dynamically back off from sending requests t...
- Sending and returning files with GPT Actions: POST requests can include up to ten files (including DALL-E generated images) from the conversation. They will be sent as URLs which are valid for five minutes.
Workflow
- Start with the reference file that matches the question.
- Prefer the most relevant file under
docs/for exact instructions and prose guidance. - Use
schemas/andexamples/for exact contracts, payloads, manifests, requests, and snippets. - Do not add behavior or configuration that is not present in the attached source files.
Canonical Sources
- https://developers.openai.com/api/docs/actions/actions-library
- https://developers.openai.com/api/docs/actions/actions-library.md
- https://developers.openai.com/api/docs/actions/authentication
- https://developers.openai.com/api/docs/actions/authentication.md
- https://developers.openai.com/api/docs/actions/data-retrieval
- https://developers.openai.com/api/docs/actions/data-retrieval.md
- https://developers.openai.com/api/docs/actions/getting-started
- https://developers.openai.com/api/docs/actions/getting-started.md
- https://developers.openai.com/api/docs/actions/getting-started/including-files
- https://developers.openai.com/api/docs/actions/getting-started/returning-files
- https://developers.openai.com/api/docs/actions/getting-started/sending-files
- https://developers.openai.com/api/docs/actions/introduction
- https://developers.openai.com/api/docs/actions/introduction.md
- https://developers.openai.com/api/docs/actions/production.md
- https://developers.openai.com/api/docs/actions/sending-files.md