API the Docs
API the Docs
  • 217
  • 56 057
Christoph Weber: Make Your Entire API Operations AI-ready with APIs.json
If APIs are supposed to be ready for AI agents, then we need machine-readable information about our entire API operation that goes well beyond API specifications like OpenAPI and AsyncAPI specifications. APIs.json addresses this need and can serve as a foundational structured data format for API discovery and automated integration.
In this talk, I show:
* The APIs.json format and what it endeavors to do exactly.
* How we added APIs.json output into our developer portal product as a first step to making APIs.json a reality on developer portals.
* Work within the broader APIs.json community to push the initiative forward.
* What you can do to help.
---
This talk was presented at AI The Docs on April 3, 2024.
AI The Docs 2024 is an online conference about AI practices in API documentation and product management. It was powered by Pronovix and kindly supported by Cloudflare, Speakeasy, MongoDB, Inkeep, kapa ai and Pieces for Developers.
**Want to learn about upcoming API The Docs projects?**
Sign up to the API The Docs newsletter to receive updates about their events, podcasts and affiliated programs: bit.ly/apithedocs
มุมมอง: 221

วีดีโอ

Neelesh Pateriya: AI in Action-10 Transformative Use Cases in API Documentation & Developer Portals
มุมมอง 1182 หลายเดือนก่อน
Artificial Intelligence has begun to reshape the landscape of API documentation and developer portals, though its integration is still in the early stages. This talk will present an in-depth look at the top ten use cases where AI proves its game-changing potential. We will explore topics such as personalized recommendation engines, AI-enabled semantic search/summary generation, chatbots, conten...
Marsh Gardiner: What changes when everyone can code? Rethinking API product journeys in an LLM-world
มุมมอง 942 หลายเดือนก่อน
Every API begins as a technical contract. When we invite others to use it, that API transforms it into a product. By adding this social contract we move into a sociotechnical space. The rise of LLMs has broadened the potential users of our API products. This challenges previous assumptions about our user base and prompts us to reexamine our approaches. How should the API product adoption journe...
John Doyle: The Future of Developer Portals in the Era of AI and Maturing Markets
มุมมอง 1202 หลายเดือนก่อน
As the digital landscape continues to evolve, the need for developer portal programs to adapt has never been more pressing. In this session, we embark on a journey to explore "The Future of Developer Portals," focusing on the essential evolution required to thrive in today's world of an exploding marketplace of competition driven by the decreasing complexity of building these tools. Join us for...
Michael Schmid: Where’s My Data Traveling When Using AI (KEYNOTE)
มุมมอง 662 หลายเดือนก่อน
AI has taken over the world of conversation interfaces in a storm and shown us the capabilities and opportunities of the future. But as with many new technologies there are also risks, one of them is Data Protection and Data Sovereignty. In this Keynote, we are going to look at how our data is traveling through different AI solutions, where the data is stored and the risks connected to that. At...
Tsavo Knott: Managing the Chaos of Modern Development Workflows
มุมมอง 892 หลายเดือนก่อน
In a modern era defined by rapid technological advancement, software development teams are increasingly confronted with many challenges, from the exponential growth of documentation, to the ballooning of large codebases, to the complexities of managing dispersed teams. As both individuals and enterprises strive to navigate this evolving landscape, the need for innovative solutions has never bee...
Garrett Winn: How AI Can Transform the Product Management of Your DevPortal
มุมมอง 582 หลายเดือนก่อน
I use AI everyday for several tasks as a technical writer and product manager of our DevPortal: * AI in our chatbot to improve responses and minimize need to contact support for common scenarios. * AI for analyzing metrics for the DevPortal, looking for patterns and doing comparative analysis across quarters. * AI for adding coding frameworks to our Portal by taking existing code and converting...
Mike Jang: Helping AI Hallucinate - It's a Whole New Language!
มุมมอง 562 หลายเดือนก่อน
Mike leads a raucous and rollicking view of AI-not only in software but throughout society. You’ll hear about the funniest (and sometimes weirdest) bits that he has seen in his first few months as a Tech Writer for an open-source vector search database company, Qdrant. Mike started prepping for AI by rewatching "2001: A Space Odyssey." He'll take the point of view of HAL 9000, as modified with ...
Tom Johnson - Principles of Prompt Engineering and How to Apply Them to Various API Docs Use Cases
มุมมอง 1202 หลายเดือนก่อน
Although AI tools provide tremendous potential, unless you know how to use these tools, much of that potential can be lost, with writers dismissing the tools as providing unreliable, error-filled text. In this session, I’ll explore some core principles of prompt engineering, such as breaking down complex tasks into subtasks, supplementing prompts with input context, applying chains of prompts, ...
Ben Perlmutter: The Generative AI Content Ecosystem
มุมมอง 962 หลายเดือนก่อน
A new content ecosystem is emerging with the rise of generative AI. Tools like ChatGPT, Github Copilot, Google Gemini, and Perplexity.ai are entrenching themselves in people's workflows. More and more companies are rolling out AI chatbots on their websites. We are witnessing a shift from static web content to bespoke content generated for each user. This session explores how you can adapt your ...
Amara Graham: The Good, Bad, and Ugly of AI + Docs
มุมมอง 832 หลายเดือนก่อน
All aboard the AI hype train! You and your team are feeling pressured to add AI to your documentation. Come on, everyone is doing it! I’d like to walk you through the aspects we encountered on our journey to bring AI to our documentation site, ingesting our docs, forums, company blogs, and more. You will hear moments of user delight, heavy skepticism, features we just had to have, and how you c...
Meaghan Choi: CLIs and LLMs: The Renaissance of the Prompt Based Experiences
มุมมอง 582 หลายเดือนก่อน
With the rising popularity of input/output based AI services, we can start rethinking how we provide information to our developer community. But, that doesn't mean we're starting from scratch. There's a lot that can be learnt from one of the early interfaces - the command line. It's time to revisit things that we once thought impossible, and also learn from some of the foundations that built th...
Ellis Pratt: Streamlining API Docs Updates: Leveraging GenAI for Enhanced Efficiency and Accuracy
มุมมอง 762 หลายเดือนก่อน
At a time where technology evolves at breakneck speed, maintaining up-to-date API documentation has become a challenge for content managers and developers. This talk looks at into a new solution to this perennial problem: the use of Generative AI, specifically OpenAI's GPTs, to automate the update process of technical documentation. We begin by exploring the necessity of keeping documentation i...
Chris Ward: Writing for Robots
มุมมอง 892 หลายเดือนก่อน
Automated processes and tools have been reading our content for some time, building humongous databases of our carefully crafted words so people can actually find them buried across the vast swathes of the internet. And now, even more automated processes and machines are reading our content, packaging it into large models that make sense to few but bring sense to so many. A lot of you listening...
Frank Kilcommins: The API Workflows Specification - Unlocking API Value for Humans and Machines
มุมมอง 1012 หลายเดือนก่อน
The disruptive power of AI comes in its ability to truly assist humans. For AI models to carry out meaningful actions upon our request, they need to leverage APIs under the hood. Interacting with APIs consistently is cumbersome for large language models, mainly down varying levels of quality in APIs and their accompanying reference documentation across the industry. With the intersection of AI ...
Emil Soerensen: Optimizing Technical Documentation for LLMs
มุมมอง 3362 หลายเดือนก่อน
Emil Soerensen: Optimizing Technical Documentation for LLMs
Stella Crowhurst and Kristian Poulstrup: Supercharging Customer Integrations with Gen AI
มุมมอง 842 หลายเดือนก่อน
Stella Crowhurst and Kristian Poulstrup: Supercharging Customer Integrations with Gen AI
Nick Gomez: Using AI to Drive Content Roadmap and Documentation Style
มุมมอง 832 หลายเดือนก่อน
Nick Gomez: Using AI to Drive Content Roadmap and Documentation Style
Nolan Di Mare Sullivan: Get Your OpenAPI Spec Ready For Code Generation
มุมมอง 722 หลายเดือนก่อน
Nolan Di Mare Sullivan: Get Your OpenAPI Spec Ready For Code Generation
Kristof Van Tomme: AI Readiness - Preparing for a World Mediated by AI
มุมมอง 492 หลายเดือนก่อน
Kristof Van Tomme: AI Readiness - Preparing for a World Mediated by AI
Showcase Your Developer Portal | Codat
มุมมอง 1502 หลายเดือนก่อน
Showcase Your Developer Portal | Codat
Showcase Your Developer Portal | Miro
มุมมอง 482 หลายเดือนก่อน
Showcase Your Developer Portal | Miro
Showcase Your Developer Portal | Mercedes
มุมมอง 592 หลายเดือนก่อน
Showcase Your Developer Portal | Mercedes
Showcase Your Developer Portal | Mapbox
มุมมอง 352 หลายเดือนก่อน
Showcase Your Developer Portal | Mapbox
Showcase Your Developer Portal | Cloudinary
มุมมอง 402 หลายเดือนก่อน
Showcase Your Developer Portal | Cloudinary
Showcase Your Developer Portal | Novopayment
มุมมอง 212 หลายเดือนก่อน
Showcase Your Developer Portal | Novopayment
Showcase Your Developer Portal | Payment hub
มุมมอง 512 หลายเดือนก่อน
Showcase Your Developer Portal | Payment hub
Showcase Your Developer Portal | Talkdesk
มุมมอง 762 หลายเดือนก่อน
Showcase Your Developer Portal | Talkdesk
Showcase Your Developer Portal | Nationwide
มุมมอง 1192 หลายเดือนก่อน
Showcase Your Developer Portal | Nationwide
Showcase Your Developer Portal | MASDR
มุมมอง 62 หลายเดือนก่อน
Showcase Your Developer Portal | MASDR

ความคิดเห็น

  • @victoriahoffer
    @victoriahoffer 3 หลายเดือนก่อน

    Good questions. Clear answers!

  • @taoli2635
    @taoli2635 6 หลายเดือนก่อน

    Very insightful talk. Thanks!

  • @codatAPI
    @codatAPI 11 หลายเดือนก่อน

    Thanks for having us!

  • @ManishRealFact
    @ManishRealFact ปีที่แล้ว

    Sir this time I am working onfido document verification in a company where I get very less money. can i do it with direct onfido If yes, then make a video about how to create an account in it.

  • @ManishRealFact
    @ManishRealFact ปีที่แล้ว

    Sir this time I am working onfido document verification in a company where I get very less money. can i do it with direct onfido If yes, then make a video about how to create an account in it. Please 🙏🙏

  • @isten-ct
    @isten-ct ปีที่แล้ว

    We are glad that our humble project with #ITCQF is one of the options for the technical writing community in Europe. Thank you Fabrizio for take us in account!

  • @DorteJacobsen-jr4gn
    @DorteJacobsen-jr4gn ปีที่แล้ว

    Thanks for an interesting talk!

  • @fasihurrehman7408
    @fasihurrehman7408 ปีที่แล้ว

    How can i get inbound sms responses

  • @fasihurrehman7408
    @fasihurrehman7408 ปีที่แล้ว

    How can i get inbound sms responses

  • @markcuello5
    @markcuello5 2 ปีที่แล้ว

    HELP

  • @mummatubeyeh3100
    @mummatubeyeh3100 2 ปีที่แล้ว

    Do you guys work for travel companies to make search portal as well ??

  • @damienk7156
    @damienk7156 2 ปีที่แล้ว

    how can a travel startup company get these api for its website ? any paperwork required for online travel agencies ?

  • @syedhannan546
    @syedhannan546 2 ปีที่แล้ว

    can onfido be used with flutter?

  • @parttimelarry
    @parttimelarry 3 ปีที่แล้ว

    Just discovered this channel! Glad someone is focusing on this. Excited to watch all of these.

  • @alexander16384
    @alexander16384 3 ปีที่แล้ว

    This is a fail

  • @chrisb4009
    @chrisb4009 3 ปีที่แล้ว

    Why not provide C# examples?

  • @fungo44
    @fungo44 3 ปีที่แล้ว

    Great presentation!

  • @domaincontroller
    @domaincontroller 4 ปีที่แล้ว

    01:10 stands for Open Authorization 01:29 easy definition 01:55 Authentication 02:06 feature integration 02:26 the requesting application needs to be registered on the provider platform 02:48 Redirect_URI 03:14 I register my app I'll get two things as client ID and client Secret 03:42 the simplest OAuth app I could think of 04:13 paints points and blessings

  • @DevsLikeUs
    @DevsLikeUs 4 ปีที่แล้ว

    Awesome episode !

  • @TerenceWight
    @TerenceWight 4 ปีที่แล้ว

    Hi. You mention at around 20:45 that it's not a good idea to use a response body with a GET request. What would you do if the data to be sent as parameters to the REST API was too large to pass in the query string? We have this situation with a handful of requests and we use a POST instead, but it is an inconsistent use of the POST HTTP verb because we are really just GETting data, not updating it. The query string has a character limit of 2K which makes a GET with request body seem like the only way out.

  • @michaskowron888
    @michaskowron888 4 ปีที่แล้ว

    Great presentation, Mike. You used really good real-world analogies to explain API documentation. Thank you!

  • @kev3084
    @kev3084 4 ปีที่แล้ว

    Keep up the great work. I think that you deserve way more views! Do you know about smzeus . c o m??? It could help you get your videos higher in the search results!!!

  • @TheMr82k
    @TheMr82k 5 ปีที่แล้ว

    It would be a little better if I could see the speaker. She's so enthusiastic.