AI production systems

Member lesson

APIs, and reading a model's documentation

Lesson 2 of 10 in AI production systems.

How to Read API Documentation · Joshua Schuett
Lesson

Reading model documentation is a skill worth having even if somebody else writes the code, because the documentation is where the real constraints are: maximum sizes, supported ratios, what happens at the content filter, how long a request may take.

A person reads a thick, worn manual leaning against a machine with several dials. One dial has a large safety pin pushed through it so it can't turn; the others move freely.
Read the manual, then pin the dial. A silent upgrade can't move what's pinned.
Member

The rest of this is for members.

You have read the opening of this lesson. The rest of it comes with a membership.

One membership covers all four courses and Brands.

  • All lessons in the four Learn courses
  • All brand breakdowns in the Brands section
  • All quizzes, flashcards and crosswords
  • An AI teacher on every lesson, for up to 60 questions a day
  • All course material published during the membership

Price

Membership is from $12 a month on the Yearly plan, which is charged at $144 once a year. Lifetime access is $59, paid once.Membership is from ₹200 a month on the Yearly plan, which is charged at ₹2,400 + GST once a year. Lifetime access is ₹3,999 + GST, paid once.

Check what stuck

Members only

You can't take this check yet.

Members answer these 3 questions and keep the ticket for this lesson. Every lesson has one.

  1. Question 1, locked

    Which of these words means this? “One address that does one thing. Generate, edit, upscale, check status.”

    • Webhook
    • Cache key
    • Endpoint
    • Prompt caching
  2. Question 2, locked

    Which of these words means this? “How the provider names builds. Pin one, or your output changes without warning.”

    • Derivative
    • Provenance
    • Rights record
    • Versioning
  3. Question 3, locked

    Which of these words means this? “A version being retired. Usually announced, frequently missed.”

    • Derivative
    • Provenance
    • Rights record
    • Deprecation

Elsewhere in the library

Hear about new courses.

Leave an email and we will tell you when something new lands. We do not write often.