openai · OpenAI Platform Docs
Quickstart | OpenAI API
A step-by-step guide to setting up and implementing an AI agent using the OpenAI API.
Derived skill
Files assembled from official documentation
Viewing SKILL.md
Quickstart | OpenAI API
A step-by-step guide to setting up and implementing an AI agent using the OpenAI API.
When To Use
Use when you need to implement a basic AI agent workflow from scratch using the OpenAI API.
Reference Files
| File | Contains | Use For |
|---|---|---|
SKILL.md | Entry point: scope, routing table, and workflow. | Start here. |
docs/quickstart-openai-api-workflow-guide.md | A guide demonstrating how to install the SDK, define an agent, run it, and add tools using TypeScript and Python. | Questions about a guide demonstrating how to install the SDK, define an agent, run it, and add tools using TypeScript and Python. |
examples/quickstart-openai-api-openai-agents-quickstart-typescript-npm-installati.text | A list of terminal commands for installing the OpenAI agents library and zod using npm in a TypeScript environment. | Exact payloads, commands, or snippets shown in A list of terminal commands for installing the OpenAI agents library and zod using npm in a TypeScript environment. |
examples/quickstart-openai-api-openai-api-agents-quickstart-javascript.text | A JavaScript code example demonstrating how to initialize and run an AI agent using the OpenAI API. | Exact payloads, commands, or snippets shown in A JavaScript code example demonstrating how to initialize and run an AI agent using the OpenAI API. |
examples/quickstart-openai-api-openai-agents-python-quickstart.text | A Python script demonstrating how to initialize an Agent and use the Runner to execute a conversation. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to initialize an Agent and use the Runner to execute a conversation. |
examples/quickstart-openai-api-openai-agents-quickstart-javascript.text | A JavaScript code example demonstrating how to initialize an Agent with a tool and history function using the OpenAI SDK. | Exact payloads, commands, or snippets shown in A JavaScript code example demonstrating how to initialize an Agent with a tool and history function using the OpenAI... |
examples/quickstart-openai-api-openai-agents-python-quickstart-2.text | A Python code example demonstrating how to initialize an Agent and a Runner using the OpenAI Agents framework. | Exact payloads, commands, or snippets shown in A Python code example demonstrating how to initialize an Agent and a Runner using the OpenAI Agents framework. |
examples/quickstart-openai-api-openai-agents-quickstart-javascript-2.text | A JavaScript code example demonstrating how to initialize multiple agents with specific instructions and a triage agent using the OpenAI Agents API. | Exact payloads, commands, or snippets shown in A JavaScript code example demonstrating how to initialize multiple agents with specific instructions and a triage age... |
examples/quickstart-openai-api-openai-agents-python-quickstart-implementation.text | A Python code implementation demonstrating how to initialize multiple agents and a runner for an OpenAI agents quickstart. | Exact payloads, commands, or snippets shown in A Python code implementation demonstrating how to initialize multiple agents and a runner for an OpenAI agents quicks... |
What This Skill Covers
- Use this page when you want the shortest path to a working SDK-based agent. The examples below use the same high-level concepts in both TypeScript and Python...
- Main sections:
Install the SDK,Create and run your first agent,Carry state into the next turn,Give the agent a tool,Add specialist agents.
Workflow
- Open the most relevant file under
docs/for the exact documented workflow and wording. - Open
schemas/files for exact structured contracts. - Open
examples/files for concrete requests, commands, snippets, and manifests. - Do not add behavior or configuration that is not present in the attached source files.
Canonical source: https://developers.openai.com/api/docs/guides/agents/quickstart