Skip to content

Guides and concepts for the OpenAI API

Endpoints, parameters, and responses

Build apps to extend ChatGPT

Build commerce flows in ChatGPT

Demo apps to get inspired

Notebook examples for building with OpenAI models

Learnings and experiences from developers

Assets for developers building with OpenAI

Search the API docs

Primary navigation

Get started

Overview
Quickstart
Models
Pricing
Libraries
Latest: GPT-5.4
Prompt guidance

Core concepts

Text generation
Code generation
Images and vision
Audio and speech
Structured output
Function calling
Responses API

Agents

Overview
Build agents
Deploy in your product
Optimize
- Agent evals
- Trace grading
Voice agents

Tools

Using tools
Web search
MCP and Connectors
Skills
Shell
Computer use
File search and retrieval
- File search
- Retrieval
Tool search
More tools

Run and scale

Conversation state
Background mode
Streaming
WebSocket mode
Webhooks
File inputs
Context management
Prompting
- Overview
- Prompt engineering
Reasoning
- Reasoning models
- Reasoning best practices

Evaluation

Getting started
Working with evals
Prompt optimizer
External models
Best practices

Realtime API

Overview
Connect
Usage

Model optimization

Optimization cycle
Fine-tuning
Graders

Specialized models

Image generation
Video generation
Text to speech
Speech to text
Deep research
Embeddings
Moderation

Going live

Production best practices
Latency optimization
Cost optimization
Accuracy optimization
Safety

Legacy APIs

Assistants API

Resources

Terms and policies
Changelog
Your data
Permissions
Rate limits
Deprecations
MCP for deep research
Developer mode
ChatGPT Actions

Getting Started

Overview
Quickstart
Explore
Pricing
Concepts

Using Codex

App
IDE Extension
CLI
Web
Integrations
Codex Security

Configuration

Config File
Speed
Rules
AGENTS.md
MCP
Skills
Subagents

Administration

Authentication
Agent approvals & security
Enterprise
Windows

Automation

Non-interactive Mode
Codex SDK
App Server
MCP Server
GitHub Action

Learn

Best practices
Videos
Blog
Cookbooks
Building AI Teams

Community

Ambassadors
Open Source Program
Meetups

Releases

Changelog
Feature Maturity
Open Source

Home
Quickstart

Core Concepts

MCP Apps in ChatGPT
MCP Server
UX principles
UI guidelines

Plan

Research use cases
Define tools
Design components

Build

Set up your server
Build your ChatGPT UI
Authenticate users
Manage state
Monetize your app
Examples

Deploy

Deploy your app
Connect from ChatGPT
Test your integration
Submit your app

Guides

Optimize Metadata
Security & Privacy
Troubleshooting

Resources

Changelog
App submission guidelines
Reference

Home

Guides

Get started
Key concepts
Production readiness

Commerce specs

Agentic Checkout
Delegated Payment

Product feeds

Overview
Onboarding
Feed spec
Best practices

Home

Home

Topics

Agents
Evals
Multimodal
Text
Guardrails
Optimization
ChatGPT
Codex
gpt-oss

Contribute

Cookbook on GitHub

All posts

Recent

From prompts to products: One year of Responses
Using skills to accelerate OSS maintenance
Building frontend UIs with Codex and Figma
Run long horizon tasks with Codex
Shell + Skills + Compaction: Tips for long-running agents that do real work

Topics

General
API
Apps SDK
Audio
Codex

Home
Docs MCP

Categories

Code
Cookbooks
Guides
Videos

Topics

Agents
Audio & Voice
Computer use
Codex
Evals
gpt-oss
Fine-tuning
Image generation
Scaling
Tools
Video generation

API API Reference Codex ChatGPT Learn

API Reference
API Reference
Responses API
Webhooks
- Events
Platform APIs
- Audio
- Videos
- Images
- Embeddings
  - Create an embedding
- Evals
- Fine Tuning
  - Jobs
    Create a job
    Retrieve a job
    List jobs
    List Events
    Cancel a job
    Pause
    Resume
    Checkpoints
    List checkpoints
  - Checkpoints
    Permissions
    Create a permission
    Retrieve a permission
    Delete a permission
    List permissions
  - Alpha
    Graders
    Run
    Validate
- Batches
- Files
- Uploads
- Models
- Moderations
  - Create a moderation
Vector Stores
- Vector Stores
- Files
- File Batches
ChatKit
- Sessions
  - Create a session
  - Cancel a session
- Threads
Containers
- Containers
- Files
Skills
- Skills
Realtime
- Calls
- Client Secrets
  - Create a client secret
- Client events
- Server events
Administration
- Overview
Chat Completions
- Chat Completions
Legacy
- Realtime Beta
  - Overview
- Assistants
- Completions
  - Create a completion

Create project role

POST/projects/{project_id}/roles

The method create is not implemented in Java, but it is available in the following languages:

HTTP