Everything you need to integrate, extend, and master the Codex platform — documentation, API references, tutorials, changelogs, and community resources in one place.
Developer First
Codex resources are built by developers, for developers. Every guide is written in Markdown, versioned in Git, and tested against live environments before publication. The API reference is generated from source annotations. The changelog is updated within hours of each release. No marketing fluff — just accurate, actionable technical content.
The Codex documentation spans from five-minute quickstart guides to deep-dive architecture references — pick your entry point and go.
The documentation is organized into five tracks. The Quickstart track covers installation, first code generation, and initial CLI configuration in under 15 minutes. The Guides track contains task-oriented articles: setting up code review automation, configuring CI/CD integration, writing custom review rules, and managing team permissions. The Reference track provides exhaustive API documentation — every endpoint, parameter, response code, and error message — generated directly from source code annotations so it stays synchronized with the platform. The Concepts track explains the architecture: how the context engine works, how the inference pipeline routes requests, how the review engine evaluates code. The Troubleshooting track addresses common issues with diagnostic steps and resolution paths.
Every documentation page includes a "Last updated" timestamp and a link to the corresponding Markdown source. The documentation is published under an open license — contributions are accepted through pull requests to the documentation repository. The search index covers all five tracks and updates within minutes of any content change.
The Codex REST API, GraphQL endpoint, and WebSocket protocol are documented with request/response examples in curl, Python, JavaScript, and Go.
The REST API follows OpenAPI 3.1 specification, with the complete specification file available for download. SDKs are provided for Python, JavaScript/TypeScript, Go, and Java — each auto-generated from the API specification with idiomatic language conventions. The GraphQL endpoint includes an interactive GraphiQL explorer for ad-hoc queries and schema introspection. The WebSocket protocol, used for real-time streaming of code generation and review results, is documented with connection lifecycle diagrams, message format specifications, and reconnection strategies. All API documentation includes authentication examples, rate limiting information, and pagination details.
For developers building custom integrations, the API reference covers the complete surface area — code generation, code review, project management, team administration, and usage analytics. Webhook configuration is documented separately in the webhook system guide, and CI/CD integration patterns are covered in the CI/CD automation section.
Practical, project-based tutorials walk you through real scenarios — setting up a monorepo, automating review for a cross-service refactor, building a custom dashboard.
Tutorials range from beginner-friendly introductions (your first Codex CLI project) to advanced architecture patterns (multi-service code generation with shared context). Each tutorial includes a complete, runnable example repository with commit history showing the progression from initial setup to finished integration. The tutorial catalog covers all major language ecosystems with equal depth — you will find production-quality examples for Python FastAPI services, React TypeScript frontends, Go microservices, and Rust CLI tools. Community-contributed tutorials are reviewed for accuracy and code quality before publication, and accepted contributors receive attribution in the resource hub.
Integration guides cover specific toolchain configurations: using Codex with GitHub Actions for automated PR review, connecting Codex to a GitLab CI pipeline, setting up Slack notifications for review completions, and embedding the Codex web widget in an internal developer portal. Each guide includes a configuration file template and troubleshooting notes for common configuration pitfalls.
Every release — CLI, IDE plugins, and platform — is documented with a detailed changelog entry including new features, bug fixes, breaking changes, and migration notes.
The changelog follows a structured format: version number, release date, categorized changes (Added, Changed, Fixed, Deprecated, Removed, Security), and a migration guide section when breaking changes are introduced. CLI releases include package checksums and installation verification commands. IDE plugin releases note the minimum supported editor version. Platform releases include API deprecation timelines — deprecated endpoints remain functional for at least 90 days after a replacement is available. An RSS feed is available for developers who want changelog updates delivered to their feed reader.
For teams that need to stay on a specific version, the changelog maintains entries for all releases dating back to the public launch. Each entry links to the corresponding documentation snapshot, so developers who have not yet upgraded can still access accurate reference material.
The Codex community includes a discussion forum, a community-contributed snippet library, and a monthly showcase of interesting integrations built by developers like you.
The community forum is the primary venue for peer support: configuration questions, integration advice, and workflow discussions. Codex engineers participate actively in the forum, answering technical questions and incorporating feedback into the product roadmap. The snippet library is a curated collection of reusable configuration templates, custom review rules, and automation scripts contributed by the community. Every month, the Codex team highlights three community-built integrations — past showcases have included a VS Code extension for inline code explanation, a CLI plugin for automated changelog generation, and a Slack bot that initiates code review from chat messages.
Paid plan subscribers receive priority support with a guaranteed four-hour first response during business hours. Enterprise customers receive a dedicated support engineer and a private Slack channel for real-time assistance. The support team is staffed by engineers who work on the platform — when you report a bug, the person responding to your ticket may be the same person who ships the fix.
Browse Codex resources by category — each section links to the relevant documentation, API reference, or community resource.
| Category | Description | Key Resources | Audience |
|---|---|---|---|
| Getting Started | Installation, first-generation, onboarding walkthrough | CLI Setup, IDE Plugins, Quickstart Guide | All users |
| API & SDK | REST, GraphQL, WebSocket references; client libraries | API Reference, SDK Docs, OpenAPI Spec | Integrators |
| Code Generation | Prompt crafting, context management, language-specific guides | AI Code Gen, Prompt Guide, Language Matrix | Developers |
| Code Review | Automated review setup, custom rules, PR integration | Code Review AI, Rule Authoring, PR Templates | Teams |
| CI/CD Integration | Pipeline configuration, webhook setup, Docker deployment | CI/CD Guide, Webhooks, Docker | DevOps |
| Security | Authentication, permissions, audit logging, compliance | Security & Compliance, IAM Guide, Audit Log Ref | Security teams |
| Community | Forums, snippet library, showcase, contribution guide | Community Forum, Snippet Library, Contributor Guide | All users |
| Changelog | Version history, release notes, migration guides | Changelog RSS, Release Archive, Migration Guides | All users |
The REST API reference, GraphQL schema, and WebSocket protocol documentation are all hosted in the resource hub under the API Reference section.
The REST API documentation follows the OpenAPI 3.1 specification, with every endpoint documented alongside request parameters, response schemas, authentication requirements, and example requests in curl, Python, JavaScript, and Go. The GraphQL schema is published in both SDL format and interactive GraphiQL explorer. The WebSocket protocol documentation includes connection lifecycle diagrams, message format specifications, heartbeat requirements, and reconnection strategies. All API documentation is regenerated from source annotations on every platform release, ensuring it stays synchronized with the live API. The complete OpenAPI specification file is available for download in JSON and YAML formats.
Yes. Every release — CLI, IDE plugins, and platform — is documented with a changelog entry listing new features, bug fixes, and breaking changes.
The changelog is updated within hours of each release across all distribution channels. Each entry follows a structured format: version number, release date, categorized changes, and migration notes when applicable. CLI releases include SHA-256 checksums for verification. IDE plugin releases note minimum supported editor versions. Platform releases include API deprecation timelines with 90-day minimum notice before removal. An RSS feed is available. The changelog archive extends back to the public launch, and each historical entry links to the corresponding documentation snapshot for teams that have not yet upgraded.
Community contributors can submit tutorials, integration guides, and example projects through the Codex Community GitHub repository. Accepted submissions are featured in the resource hub.
The contribution process is designed to be lightweight. Fork the community repository, write your tutorial in Markdown following the provided style guide, and open a pull request. A Codex engineer will review the submission for technical accuracy, code quality, and adherence to the documentation style. Review typically completes within five business days. Accepted contributions are published in the resource hub with full attribution to the author — your name, a link to your profile, and a brief bio. The community repository also accepts example projects (complete, runnable repositories demonstrating Codex integrations), custom review rules, and CLI configuration templates. Contributors who submit three or more accepted pieces receive a community contributor badge and early access to beta features.
All Codex documentation is written in Markdown, versioned alongside the platform source, and rendered through a static site generator. Every page includes a 'Last updated' timestamp.
Markdown was chosen because it is the format developers already use — the same format as README files, GitHub issues, and internal wikis. The documentation source lives in the same repository as the platform code, which means documentation changes go through the same CI pipeline as code changes: linting, link checking, and a build verification step that confirms all code examples compile and run correctly. The documentation is rendered using a custom static site generator that produces the final HTML served in the resource hub. Every page displays a "Last updated" timestamp in UTC and a link to the Markdown source on GitHub. An open license permits forking, modification, and redistribution of the documentation.
Yes. The resource hub includes a full-text search across documentation, API references, changelog entries, and community-contributed articles.
The search engine indexes all content in the resource hub — documentation pages, API reference sections, changelog entries, community tutorials, and forum discussions. Search supports phrase matching, field filtering (restrict results to a specific section), and fuzzy matching for typo-tolerant queries. The index updates within minutes of any content addition or modification. Search results include a relevance-ranked snippet showing the matched text in context and a direct link to the relevant page or section. For developers who prefer not to use the web interface, the same search index powers the `codex docs search` CLI command, which returns results directly in the terminal.
Explore the resource hub, install the CLI, and generate your first piece of production code in under five minutes.
Download Codex FreeComplete guides, API references, and troubleshooting across all platform features.
Install the Codex CLI and start generating code from your terminal.
Connect Codex to VS Code, JetBrains, Neovim, and other editors.
REST, GraphQL, and WebSocket documentation with code examples.
Learn about our founding, mission, and engineering philosophy.
Reach support, sales, or schedule a platform walkthrough.
The Codex resource hub is the central entry point for all developer-facing content — from the full documentation covering every platform feature to the comprehensive API reference with request examples in four languages. Developers integrating Codex into their toolchain typically start with the CLI installation guide or the IDE plugin setup for their preferred editor, then progress to more advanced topics like CI/CD pipeline integration and webhook configuration. The Docker deployment guide covers containerized environments, while community-contributed tutorials offer practical walkthroughs for real-world scenarios.
Beyond documentation, the resource hub connects to other areas of the platform. Review the security and compliance documentation for information about encryption, certifications, and data handling. Browse pricing plans to understand which tier includes the features your team needs. Read about the Codex platform story and meet the lead engineering team. If you encounter an issue not covered by the troubleshooting guides, the contact page lists support channels and response times for each plan tier.