How do I install the Ingesting Spec skill?

Run npx skillmds@latest add openai/ingesting-spec in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Ingesting Spec safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. Capability flags: makes network calls. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Ingesting Spec?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Ingesting Spec free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Ingesting Spec?

OpenAI (@openai) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Ingesting Spec by openai — Agent Skill

Name: Ingesting Spec
Rating: 4.2 (5 reviews)
Author: OpenAI

Ingesting Spec

Guide for ingesting the latest OpenAI TypeSpec specification into the openai-dotnet SDK. Use this when asked to update or ingest OpenAI API specs, copy base TypeSpec files from upstream, fix client TSP compile errors, or run code generation for new API areas.

OpenAI Updated Sep 10, 2026 23.3k repo stars

File contents

Spec Ingestion

Overview

This skill describes how to ingest the latest OpenAI TypeSpec specification (from the upstream microsoft/openai-openapi-pr repository) into the openai-dotnet SDK, area by area.

The process involves:

Copying updated base specs from upstream
Reporting any compile errors in the base TSP
Fixing compile errors in the client TSP layer
Preserving custom C# code (renames, stubs)
Running code generation
Verifying the output

Skill Documents

This skill is split across multiple files for easier navigation:

Document	Description
steps.md	Step-by-step process — the full 9-step workflow from copying spec to post-generation verification
file-locations.md	Key file locations — quick reference for all upstream and local paths, area mappings
patterns-and-gotchas.md	Common patterns & gotchas — lessons learned, pitfalls, and conventions to follow
checklist.md	Checklist — a task-by-task checklist for tracking progress during an ingestion
references.md	Reference PRs — detailed notes on past ingestion PRs with lessons learned

Quick Start

Review references.md for examples of past ingestions in your area
Read file-locations.md to understand the repo layout
Follow steps.md for the full ingestion workflow
Use checklist.md to track your progress
Consult patterns-and-gotchas.md when you hit issues

Available Areas

Areas that can be ingested independently:

administration · assistants · audio · batch · chat · containers · conversations · embeddings · evals · files · fine-tuning · graders · images · models · moderations · realtime · responses · runs · threads · vector-stores · videos

Key Rules

Always add @@clientLocation for every operation in the client TSP (the latest spec no longer uses interface blocks)
Update [CodeGenType] stubs in src/Custom/{Area}/Internal/GeneratorStubs.cs for any renamed types
Defer complex features — suggest them as follow-up items rather than implementing in the same ingestion
Run ./scripts/Invoke-CodeGen.ps1 to generate code (warnings are OK. Errors are not), then dotnet build to verify (Should be no warnings or errors)
Work locally only — do NOT create PRs or file issues. Instead, suggest a list of issues that may need to be filed upstream

---name: ingesting-specdescription: Guide for ingesting the latest OpenAI TypeSpec specification into the openai-dotnet SDK. Use this when asked to update or ingest OpenAI API specs, copy base TypeSpec files from upstream, fix client TSP compile errors, or run code generation for new API areas.---# Spec Ingestion## OverviewThis skill describes how to ingest the latest OpenAI TypeSpec specification (from the upstream [`microsoft/openai-openapi-pr`](https://github.com/microsoft/openai-openapi-pr) repository) into the `openai-dotnet` SDK, area by area.The process involves:1. Copying updated base specs from upstream2. Reporting any compile errors in the base TSP3. Fixing compile errors in the client TSP layer4. Preserving custom C# code (renames, stubs)5. Running code generation6. Verifying the output## Skill DocumentsThis skill is split across multiple files for easier navigation:| Document | Description ||----------|-------------|| [steps.md](steps.md) | **Step-by-step process** — the full 9-step workflow from copying spec to post-generation verification || [file-locations.md](file-locations.md) | **Key file locations** — quick reference for all upstream and local paths, area mappings || [patterns-and-gotchas.md](patterns-and-gotchas.md) | **Common patterns & gotchas** — lessons learned, pitfalls, and conventions to follow || [checklist.md](checklist.md) | **Checklist** — a task-by-task checklist for tracking progress during an ingestion || [references.md](references.md) | **Reference PRs** — detailed notes on past ingestion PRs with lessons learned |## Quick Start1. Review [references.md](references.md) for examples of past ingestions in your area2. Read [file-locations.md](file-locations.md) to understand the repo layout3. Follow [steps.md](steps.md) for the full ingestion workflow4. Use [checklist.md](checklist.md) to track your progress5. Consult [patterns-and-gotchas.md](patterns-and-gotchas.md) when you hit issues## Available AreasAreas that can be ingested independently:`administration` · `assistants` · `audio` · `batch` · `chat` · `containers` · `conversations` · `embeddings` · `evals` · `files` · `fine-tuning` · `graders` · `images` · `models` · `moderations` · `realtime` · `responses` · `runs` · `threads` · `vector-stores` · `videos`## Key Rules1. **Always add `@@clientLocation`** for every operation in the client TSP (the latest spec no longer uses `interface` blocks)2. **Update `[CodeGenType]` stubs** in `src/Custom/{Area}/Internal/GeneratorStubs.cs` for any renamed types3. **Defer complex features** — suggest them as follow-up items rather than implementing in the same ingestion4. **Run `./scripts/Invoke-CodeGen.ps1`** to generate code (warnings are OK. Errors are not), then `dotnet build` to verify (Should be no warnings or errors)5. **Work locally only** — do NOT create PRs or file issues. Instead, suggest a list of issues that may need to be filed upstream

Frequently asked questions