Profile cover
C

AI API Reference Generator

Charlotte Tran

Contract · Job · Chicago

About the role

API documentation is either auto-generated and useless or hand-written and outdated. Our platform finds the middle ground — using AI to generate API reference documentation that includes not just endpoint signatures, but usage examples, common error scenarios, and migration notes when APIs change. This 8-month contract focuses on the generation pipeline: parsing API specifications (OpenAPI, GraphQL schemas), generating contextual usage examples by analyzing API call patterns from production logs, and building the change detection system that automatically drafts documentation updates when API behavior changes. The hardest part isn't generation — it's quality calibration. Auto-generated examples that don't actually work are worse than no examples. You'll build the verification layer that tests every generated example against a live sandbox environment before it publishes.

Responsibilities

  • Build documentation generation pipelines from OpenAPI and GraphQL specifications
  • Generate contextual API usage examples from production call pattern analysis
  • Design change detection drafting documentation updates on API behavior changes
  • Build verification layers testing generated examples against live sandbox environments
  • Calibrate documentation verbosity for developer utility

Requirements

  • 3+ years in developer tools or API documentation engineering
  • Hands-on LangChain and OpenAI API experience
  • Understanding of API specification formats (OpenAPI, GraphQL)
  • Strong Python skills with FastAPI
  • Good judgment about what developers need in API reference documentation

Benefits

  • 8-month contract with extension option
  • Fully remote — US time zones
  • Competitive contract rate
  • Improving API developer experience at scale

Keep exploring related roles

Use these topic pages to discover more roles in the same hiring cluster.

Job Type

Contract

Level

Mid-Level

Language

English

Salary Range

$100k – $130k / year

AI Expertise

Automation & AI Workflows NLP & Prompt Engineering

Skills

python openai api langchain fastapi docker

Ready to apply for this role?

Create a free talent account in under 2 minutes.

  • Apply to verified AI companies
  • Get AI-matched job recommendations
  • Message hiring managers directly
  • Build your public AI talent profile

Interested in this role? Create your free profile to apply.

Apply — create free profile