Skip to main content

Christoph Weber (Pronovix): Make Your Entire API Operations AI-ready with APIs.json

AI The Docs 2024 Recap

This talk was presented at the AI The Docs online conference on April 4, 2024. We are thrilled to share the recording and the summary with you.

Visit the talk summary page to see all of the presentations from the conference.



 

Christoph Weber

Sr. Product Extensions Manager and Solutions Architect at Pronovix

 

Christoph's presentation

 

 

In this presentation, Chris explains the role of structured data in modern API operations and AI readiness. By introducing APIs.JSON, he sheds light on a data format designed to comprehensively document and organize APIs.
 

Key Takeaways

Structured Data Importance:
Structured data is critical for ensuring that APIs are AI-ready. It helps prevent the “garbage in, garbage out” problem by providing high-quality inputs for meaningful AI outputs.
Introduction to APIs.JSON:
APIs.JSON goes beyond traditional specifications like OpenAPI. It includes comprehensive documentation of API operations, from properties and schemas to authentication and SDKs.
AI Model Training:
APIs.JSON guides AI models to high-quality, curated content. It improves the accuracy and relevance of AI-generated outputs.
API Consumption & Integration:
APIs.JSON acts as a signpost for AI and bots, ensuring they access the correct information. It prevents low-quality content dissemination and standardizes information architecture across developer portals.
Adoption & Future Plans:
Chris encourages adopting APIs.JSON to enhance API documentation and integration. Upcoming support for APIs.JSON in their products and plans for a Drupal module to help others implement this format.
 

Sign up to our Developer Portal Newsletter so that you never miss out on the latest API The Docs recaps and our devportal, API documentation and Developer Experience research publications.

 

Sign up

 

Newsletter

Articles on devportals, DX and API docs, event recaps, webinars, and more. Sign up to be up to date with the latest trends and best practices.

 

Subscribe