🤖 Build with AI Agents – $150 | 24 hours only

This week’s challenge is officially live! One winner will take home a $150 Postman swag pack.

Prompt: What would you build using Postman’s new AI agent templates? Got a repetitive task? A workflow that needs superpowers? Tell us what you’d build with these plug-and-play agent templates:→ Browse templates here

Bonus points for: Unexpected or quirky use cases, real-world problems you’d actually solve, clarity on how it would work.

Want a shot at another prize?
If your response includes a Postman Notebook, you’ll also be entered into a $250 mini-giveaway as part of the Notebook Challenge.

Yes, you can win twice. Just link your Notebook in your reply.

Reply below before 12pm PT Thursday.

We’ll announce the winner on Friday. Let’s see what your inner builder would create.

14 Likes

“Bug Doctor” – Auto-Diagnosis + Fix Recommendations Agent

:puzzle_piece: Problem:

API test failures often leave devs guessing — is it the environment? Auth? Body format?

:light_bulb: Agent Idea:

An agent that:

  • Parses failing test assertions across Postman collections.
  • Runs root cause analysis by chaining requests and examining variables/envs.
  • Auto-generates a “diagnosis report” and possible fixes (e.g., “Your OAuth token may be expired”, “Missing Content-Type header”).

Bonus: Could auto-open a GitHub issue with findings.

1 Like

Here’s what I’d build to make my daily work easier:

1. Auto API Checker

The Problem: I manually test 20+ APIs every morning My Solution: An AI agent that checks all my endpoints and tells me what’s broken.

Using Postman:

  • Set up my API collection
  • Agent runs tests every hour
  • Sends me a message when something fails
  • Creates a simple report showing what’s working

2. Easy Documentation Helper

The Problem: My API docs are always out of date My Solution: Agent updates documentation when I change my code.

How it works:

  • Connect to my code repository
  • Agent sees when I update an API
  • Automatically fixes the documentation
  • Keeps everything current without me remembering

3. Simple Load Tester

The Problem: Don’t know if my API can handle traffic My Solution: Smart testing that gradually increases load.

With Postman:

  • Start with 10 users, then 100, then 1000
  • Agent watches response times
  • Stops before breaking anything
  • Shows me where my limits are

4. Test Data Maker

The Problem: Creating fake users and data takes forever My Solution: Agent generates realistic test data instantly.

The Setup:

  • Tell it what kind of data I need
  • Creates hundreds of fake users
  • Makes data that looks real
  • Saves me hours of manual work

:light_bulb: Why This Matters

These agents handle the boring stuff so I can focus on building cool features. Instead of spending 2 hours testing, I spend 5 minutes setting up automation.

My code gets better because I catch problems faster. My team stays happy because everything works smoothly.

3 Likes

The Al agent that I think would help with its superpowers is Summarize and Analyze Industry News AI agent

Problem

Product managers, developers, or marketers struggle to stay on top of fast-moving industry news. Sifting through multiple sources daily is time-consuming, and important signals often get buried in noise.

This agent solves that by:

  • Scraping relevant news articles daily.
  • Summarizing them with AI into quick bullet points.
  • Highlighting sentiment, trends, and urgency.
  • Sending a daily digest to a Slack channel, Notion page, or email.

How It Would Work (Step-by-Step)

  • Use APIs or RSS feeds from Hacker News API, TechCrunch RSS, Product Hunt API.
  • Use Postman Flows to pull latest items, filter for keywords (e.g., “AI”, “developer tools”, “open source”)
  • Use an LLM (e.g., OpenAI via Postman plugin) to summarize title + body and extract:
    • Key points
    • Category (DevTools, Funding, Acquisition, etc.)
    • Sentiment (Excitement, Criticism, Caution)
    • Actionable takeaways
  • Format the digest with emojis, headlines, links and send them
    • Slack channel (#product-news)
    • Notion doc with weekly archives
    • Daily email via Mailchimp or SendGrid

Unexpected/Quirky Use Cases

  • “Snarky News Bot” for Developer Memes
    Example:
    • Original: “OpenAI releases GPT-5”
    • Snarky Digest: “Skynet takes another step. GPT-5 is here, and your job just flinched.”
  • News Digest for Bootcamp Students
    • Agent only fetches articles with keywords like “launch,” “beta,” “leaked,” “exclusive.”
    • Perfect for techies who only want new and shiny toys.

Bonus

Metrics You Could Track

  • Most cited topics this week
  • Trending categories (e.g., surge in AI infra news)
4 Likes

Automated API Doctor
This Postman AI agent acts as your always-on API monitoring and first-responder system.
Problem: Manual API health checks are slow and reactive, making root cause analysis a pain.
How it Works:
Scheduled Health Check Agent: Runs periodically (e.g., every 15 minutes) across critical API endpoints. It executes requests and comprehensive tests (status, performance, schema).
Intelligent Alerting & Diagnosis Agent: If a test fails, this agent kicks in.
It analyzes failures (error codes, response content, latency).
Using Postman’s AI, it diagnoses the likely cause (e.g., “Auth token expired,” “Missing parameter”).
It then generates detailed alerts (Slack, Jira, email) with failure details and AI-suggested solutions.
Bonus: Self-Healing: For common issues like expired tokens, the agent can automatically attempt a fix (e.g., refresh token) and re-run the test. If successful, it sends a “Self-healed!” notification, minimizing manual intervention.

6 Likes

API Mood Maestro

I’d use Postman’s AI agent templates to build an “API Mood Maestro” a plug-and-play agent that scans recent customer support tickets (from APIs like Zendesk or Freshdesk), analyzes sentiment and then automatically triggers the right follow-up action via other APIs (Slack, SMS, escalate ticket, or send a personalized thank-you). This saves teams hours of manual triage and makes sure no urgent or unhappy ticket slips through the cracks.

If the sentiment is unusually positive (someone’s thrilled), the agent could surprise both the customer and their handler by sending a digital badge or even a coffee gift card entirely automated, via API.

How it works:

  • Agent pulls latest tickets with one click.
  • AI analyzes mood/sentiment in real-time.
  • For negative moods, it triggers escalation or personalized outreach.
  • For positive moods, it celebrates success, rewarding both the customer and agent.

A Notebook would document the workflow listing each action, decision point, sample API requests/responses, and showing real-time results.

This solves the real-world headache of support team overload and ensures customer happiness, all powered by Postman’s new AI Agents.

5 Likes

What I’d build with Postman AI agent templates:
I’d create a Postman agent called the “404 Therapist” — it detects repeated API failures (like 404s, 500s, or timeouts), tries to diagnose the issue, and responds with both technical suggestions and a bit of emotional support to keep you sane during debugging.

Why this?
APIs break. Sometimes it’s your fault. Sometimes it’s the third-party service. Either way, it’s frustrating. I wanted something that doesn’t just point to the problem but makes the process less painful.

How it works:

Uses the error log monitoring template to watch for repeated failed responses across APIs I use.

Automatically inspects recent requests and responses for patterns (e.g., malformed URLs, expired tokens).

Suggests fixes using the natural language summarizer and API documentation lookup agents.

Sends me a Slack message like:

“I noticed 14 failed calls to /v2/user/info. That endpoint was deprecated last week. You might want to update the request. And hey, breathe. You’re doing great.”

Bonus: Every major issue comes with a calming GIF from a built-in GIPHY API integration

Why it’s useful and different:
It’s not just a monitor. It’s a helpful companion for chaotic dev days. Quirky? Definitely. But useful, memorable, and a morale-booster.

TL;DR: I’d build an AI agent that finds bugs and gives hugs.

3 Likes

Problem Statement
Keeping API documentation in sync with code changes is a perpetual headache. Every time a developer tweaks an endpoint adding a new parameter, renaming a field, or updating an example response the Postman Collection docs fall out of date.
Code-to-Docs Synchronizer Agent
By repurposing Postman’s Industry News Updates and Analysis agent, we can transform “daily news” into “daily diffs,” automatically keeping our docs current. Here’s how it works end-to-end:

  1. Fetch PR Diff
  • Trigger on each merge to main (e.g., via a GitHub webhook).
  • Agent calls GitHub’s API to retrieve the list of changed files for the pull request:
    GET https://api.github.com/repos/{{repo_owner}}/{{repo_name}}/pulls/{{pr_number}}/files
  1. Analyze Changes
  • Use the agent’s built-in summarization step (originally designed for news articles) to digest the diff:
    – Identify which endpoints and methods changed
    – Highlight added, removed, or renamed parameters
    – Extract new example request/response snippets
  1. Update Postman Collection
  • Agent calls the Postman API to programmatically update the corresponding request descriptions and example bodies in your published Collection:
    PATCH https://api.getpostman.com/collections/{{collection_uid}}
  • The request body contains the updated description fields and sample payloads based on the diff analysis.
  1. Notify the Team
  • Finally, the agent sends a friendly Slack message to your dev channel with:
    – A brief summary (“Docs updated for POST /orders: added discountCode parameter.”)
    – Direct links to the updated Collection and the GitHub PR
  1. Configuration
  • Required environment variables in the agent:
    – github_token, repo_owner, repo_name
    – collection_uid
    – slack_bot_token, slack_channel_id

Bonus points :

  • Simplifies debugging of client integrations tied to older API versions, making rollbacks and support far easier.
  • When two repos share common API patterns, the agent can suggest reusing updated examples across both Collections so you avoid duplicating efforts.

notebook : Postman

15 Likes

Smart Classroom Assistant


What is the problem?

I am thinking about teachers in my country, maybe also in other places. They have so many students and too many things to do. They must send homework, remind students, collect many files, check who is late, and also talk with parents. Every tool is different – Google Classroom, Gmail, WhatsApp, sometimes just paper. It is very hard to manage all, and teacher is tired.


My idea: Smart Classroom Assistant using Postman AI Agent templates

If I can use Postman’s AI agent templates, I want to make a helper for teachers. The helper will connect to APIs that already exist – like Google Classroom API, Gmail API, Twilio SMS, Google Sheets. It will do almost all boring tasks for the teacher.


How it will work (step by step, with real APIs):

1. Assignment Creation & Distribution

Teacher creates new homework in Google Classroom.
Postman agent will use Google Classroom API to send the work to every student.

POST https://classroom.googleapis.com/v1/courses/{courseId}/courseWork
Content-Type: application/json

{
  "title": "Math Homework 1",
  "description": "Please solve exercise 1 to 10.",
  "dueDate": {"year":2025,"month":8,"day":5}
}

2. Automated Reminders

Before the deadline, Postman agent will use Twilio SMS API or Gmail API to remind students.

POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Messages.json
Content-Type: application/x-www-form-urlencoded

From=+1234567890&To=+1098765432&Body=Hi! Math homework is due soon. Please submit in Google Classroom.

3. Collect Submission

Students upload their work in Google Classroom.
The agent uses Google Classroom API to check who sent and who did not.

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions

4. Grading & Feedback

For quizzes, can use Google Forms API for checking answers fast.
For feedback, send a simple message to student by Gmail API.


5. Progress Tracking & Parent Info

Agent writes results in Google Sheets.
Every week, the agent sends an update to parents with Gmail API.


Why this is good and maybe a bit fun

  • Agent can send reminder with student’s name. “Hello Hana, your homework is almost due! You are doing great.”
  • If student is always on time, agent can send a smiley face or “Good job!”
  • If student is late, agent will send a kind message, not angry.
  • Teacher does not need to open many apps, just use Postman workspace with all steps ready.
  • All APIs are real – Google, Twilio, Gmail, Sheets – not fake.
  • Teacher saves time, less stress.
  • Student does not forget homework.
  • Parent knows student progress.
  • All work is organized—no lost homework, less confusion.
  • Use real APIs from Google, Twilio, Gmail, etc—not just mock.

Does it match the challenge?

  • Solves a real problem: Teachers can relax a bit, students and parents know what is happening.
  • Uses Postman AI agent templates: All done with Postman Collections, flows, variables, and public APIs.
  • Unexpected or quirky: Agent can even give small “rewards” to students, or make a simple leaderboard in Google Sheets.
  • Easy to understand: Every step is clear, no new app to learn, only connect things that already exist.
  • Superpower: One teacher, hundreds of students – still possible with this agent.

This agent saves time for teachers and helps students. It connects everything and makes school life simple.

5 Likes

What I’d build using Postman’s AI Agent Templates:
:broom: “The Sandbox Refresher” – an automated agent that resets and sanitizes your API sandbox environment every night, keeping things clean, consistent, and ready for testing the next day.

⸻

:thought_balloon: The Problem

Shared sandbox environments tend to get messy — fast.

During development and testing, different people hit the same endpoints with test data, half-finished payloads, and broken states. Within a couple of days, your sandbox environment looks nothing like a real scenario.
What’s worse? Debugging in a cluttered environment introduces flaky test results and confusion for teammates. Especially if your API depends on authentication tokens, quotas, or time-sensitive resources, resetting manually becomes a time sink.

⸻

:white_check_mark: My Solution: The “Sandbox Refresher” Agent

Using Postman’s AI Agent Templates, I’d build a daily maintenance bot that restores sandbox environments to a known, working state — automatically.

Here’s how it would work:

⸻

:repeat_button: 1. Scheduled Trigger

Every night at a set time (e.g., 3:00 AM), the agent kicks off using a scheduled collection run via Postman Monitors or a cron-style trigger through an external orchestrator like GitHub Actions.

⸻

:soap: 2. Perform Cleanup Tasks
• DELETE /test-users, DELETE /temp-orders, etc., to wipe test data
• PUT /config/defaults to reset configuration settings
• PATCH /quota to restore rate limits
• Re-authenticate and refresh access tokens where needed (e.g., for OAuth2 workflows)

⸻

:test_tube: 3. Seed Fresh Test Data

Using templated JSON bodies or saved environments, the agent sends predefined POST requests to repopulate the sandbox with clean, meaningful test data:

{
“name”: “Test User A”,
“email”: “[email protected]”,
“role”: “tester”
}

:magnifying_glass_tilted_right: 4. Run Smoke Tests

Once reset and seeded, the agent pings key endpoints (GET /health, GET /user/profile, etc.) and checks for expected status codes and responses to confirm everything is working.

⸻

:envelope_with_arrow: 5. Notify the Team

Finally, the agent sends a Slack or email summary:

“Sandbox reset complete :white_check_mark:
• 30 test users deleted
• 15 seeded
• Access tokens refreshed
• All smoke tests passed”

If any issues occur (e.g., 500 errors, auth failures), the agent reports them along with suggested fixes based on API error messages and documentation snippets.

⸻

:sparkles: Bonus Features
• Toggle between “full reset” or “light cleanup” using a config flag
• Maintain backups of known-good sandbox states for rollback
• Track changes over time (e.g., number of resets, average API errors, stale tokens)

⸻

:rocket: Why this is useful

Dev teams often forget the importance of a reliable and repeatable test environment. A broken sandbox leads to wasted time, misdiagnosed bugs, and slower releases.
This agent helps ensure a clean slate every morning — making it easier to onboard new devs, run consistent tests, and avoid messy surprises.

It’s like an overnight janitor for your APIs. Quiet, dependable, and always leaves things better than they were.

⸻

:test_tube: I’m currently working on turning this into a Postman Notebook — will update this thread with the link once it’s live.

3 Likes

Meeting Minute Magician: Instant Action Items from Meeting Summaries**

What it solves:
In many organizations, team members spend unnecessary time parsing meeting summaries to extract action items, chase updates, or generate tickets in project management tools. This task is time-consuming, repetitive, and sometimes error-prone.

How I’d use Postman AI Agent Templates:
I’d use the “AI Extractor” and “Webhook Trigger” agent templates from Postman to build an automated workflow:

  1. Incoming Meeting Summary:
    As soon as a meeting ends, the minutes/summary (from tools like Zoom, Google Meet, or even just an email) are sent to a Postman collection endpoint through a webhook.
  2. AI-Powered Extraction:
    The AI Extractor template analyzes the summary, intelligently identifies action items, owners, and deadlines, and structures them in JSON.
  3. Automated Routing:
  • If the action item relates to bug fixing, it automatically creates a ticket in Jira via the Jira API.
  • For HR-related tasks, it triggers a Slack DM or email to the responsible person.
  • If there’s a need to update documentation, it posts a GitHub issue or sends a Notion update.
  1. Summarized Feedback Loop:
    The workflow sends a concise, actionable agenda to the team on Slack/Teams so everyone’s on the same page, instantly.

Unexpected & Quirky Twist:
The system can also add a fun “meeting meme” at the end of each summary by pulling from a meme API, tailored to the meeting sentiment (calm, chaotic, or celebratory), determined by sentimental scoring in Postman’s flow!

Why this matters:
This isn’t just a quirky takeover—it solves a real productivity drain for teams, reduces human error, and brings order to the chaos of collaborative meetings. Plus, with minimal setup thanks to Postman’s agent templates, even non-coders can automate tedious workflows and add a dash of humor to their daily grind.

Bonus:
Integrate a reminder system—automatically pinging team members before action item deadlines, again using Postman flows.

In summary:
Postman’s new AI agent templates make it possible to automate meeting follow-up tasks end-to-end, saving hours each week, boosting accountability, and bringing a smile to every wrap-up with a customized meme.

4 Likes

:hammer_and_wrench: API Change Impact Notifier (Built with Postman AI Agent Templates)

:puzzle_piece: The Real-World Problem:

I’m working on a mobile app. One day it works fine the next day it breaks… and I didn’t even touch it!
Turns out the backend team updated the API - changed a field name, deleted a parameter
:backhand_index_pointing_right: and forgot to tell us.
This isn’t rare. It happens a lot. And it wastes hours of debugging time.


:light_bulb: The Solution I’d Build:

An AI-powered API Change Notifier Agent using Postman’s plug-and-play agent templates.

What it does:
Watches for changes in API definitions (like OpenAPI/Swagger files), detects breaking changes, and notifies the right teams automatically.


:magnifying_glass_tilted_left: How It Would Work (Step-by-Step):

  1. :brain: Source: Connect to GitHub where API specs live (in OpenAPI format).
  2. :hammer_and_wrench: Detection: Whenever someone makes a pull request or commit, the agent checks for structural changes like:
  • Deleted or renamed fields
  • Changed response format
  • New required parameters
  1. :loudspeaker: Notification: If something could break the app:
  • The agent posts a clear summary in Slack (e.g., #api-updates)
  • Optionally, it opens a Jira or GitHub issue for tracking
  1. :receipt: Reporting: Sends a weekly digest of API changes so teams stay updated even if they missed the alert.

:white_check_mark: Why This Matters:

  • Frontend/mobile/backend teams stay in sync
  • Breakage is avoided before it happens
  • No need to manually review API diffs
  • Saves real-world teams real time

:electric_plug: Built on These Postman AI Templates:

  • GitHub Issue Prioritization Agent: For repo monitoring
  • Incident Management Agent: For status updates
    With extra logic for API schema comparison + team alerts

:collision: Bonus Notebook (for Extra Prize Entry):

I’ll also include a Postman Notebook showing:

  • How the agent connects to a GitHub repo
  • Sample OpenAPI change detection
  • Test run of notifications into Slack or GitHub
    This will help others easily recreate and customize the agent.

:bullseye: Why It’s Quirky + Useful:

Most people think of monitoring servers or incidents not monitoring API contracts for silent breakage.
It solves a real-world team pain point, especially in fast-moving startups and dev teams.

6 Likes

Roast My API — A Talking Back Postman Notebook

What I Made:

I made a Postman Notebook that doesn’t make the ordinary call to an API — it roasts it.

The concept is straightforward: rather than testing APIs the old-fashioned way, I wanted to make it engaging, interactive, and brutally real. I utilized Postman’s AI technology to inspect and snarkily review API responses, much like an irritable developer might in a late-night code critique.

Imagined as a developer tool with the personality of a stand-up comedian.

The Concept:

All APIs give back a response — but not all responses are worthy of a standing ovation. This notebook applies to a real API (a random joke API here) and passes the JSON response into Postman AI with a prompt that requests it to roast the response structure.

It considers things such as:

  1. Field names (e.g., are they too generic?)
  2. Design decisions (e.g., why split “setup” and “punchline”)
  3. Unused or clunky fields (e.g., arbitrary “id” with no purpose)
  4. Missed potential (e.g., might the response be more helpful?)

And rather than being a polite suggestion, it gets full savage — all in good humor, and with unexpectedly solid technical criticism.

How It Works:

  1. The Notebook invokes a joke API and retrieves a random joke.
  2. Postman AI is challenged to roast the JSON response’s structure.

The end result is displayed through Postman’s visualizer: you see the original joke and a snarky, technically knowledgeable roast, side by side.

Each time you execute it, you receive a different joke and a new roast — which makes this a reproducible and strangely engaging experience.

Why This Matters:

This isn’t a gimmick — it’s an innovative way to:

  1. Think critically about API design
  2. Make API exploration more fun
  3. Learn what constitutes a “good” or “bad” response in practice

It’s also a great introduction to using Postman Notebooks, which leads into much more interactive and dynamic workflows within Postman.

Challenges Along the Way:

Some of the public APIs (such as FakeStoreAPI) weren’t collaborative — they block Postman with security filters like Cloudflare. Rather than struggle with it, I switched to a cleaner, more stable API. It’s funny, even joke APIs get judged — and sometimes they deserve it.

Try It Yourself:

Ever want to see a joke get dragged by a machine?
Here’s the Notebook link Postman

Go for it, run it.

Final Thoughts:

This small experiment began in jest (literally), but it wound up demonstrating how testing tools and AI can combine in novel, imaginative ways. You don’t necessarily need a large project — sometimes the most innovative ideas come from creating something simple. a little quirky.

If APIs were capable of crying, this notebook would be the cause.

15 Likes

:police_car_light: API Threat Hunter – AI-Powered API Security Auditor

Built with Postman AI Agent Templates
By Rishabh Kr. Pandey


:brain: What I Built:

API Threat Hunter is an intelligent Postman Notebook that scans any public API for common security vulnerabilities no setup, no scripts, just results.

Think of it as an AI-powered bug bounty assistant that detects:

  • :unlocked: Missing Authentication
  • :dna: Exposed Personal Data (PII)
  • :globe_with_meridians: Insecure Headers (CORS, CSP, etc.)
  • :high_voltage: Missing Rate Limiting & Misconfigurations

:bullseye: Real-World Problem It Solves:

Most APIs are launched without proper security checks. Developers miss common flaws like overly permissive CORS or leaking emails/IPs in responses.

API Threat Hunter automates those checks in under 30 seconds helping:

  • Devs ensure API hygiene
  • Students learn API security
  • Bug bounty hunters pre-scan targets
  • Startups improve their API defenses

:hammer_and_wrench: How It Works:

  1. :link: User enters any public API URL
  2. :satellite_antenna: GET request fetches the API response
  3. :brain: Postman AI analyzes:
  • Headers (Auth, CORS, CSP, etc.)
  • Body for personal/sensitive info (email, IPs, phone, etc.)
  1. :clipboard: Combines findings into a security report with severity levels
  2. :desktop_computer: Visualizer displays a styled summary (perfect for devs & auditors)

:laptop: Notebook Link:

:play_button: Open API Threat Hunter in Postman


:sparkles: What Makes It Unique:

  • AI finds bugs you didn’t think to look for
  • Empowers non-security folks to do recon
  • No SDKs, no auth, just plug-and-scan
  • Built 100% in Postman using native AI agent templates
  • Gamifies security checks with emojis & styled summaries

:trophy: Submitting for:

:white_check_mark: Main AI Agent Templates Challenge – Most Useful Workflow
:white_check_mark: Notebook Mini-Challenge – Linked Notebook Included!

6 Likes

:stopwatch: That’s a wrap!

This week’s challenge is officially closed. Thanks to everyone who joined! :heart:

While we review submissions, drop a like on your favorite responses. It helps us pick a winner.

See you back here on Friday.

2 Likes

I’d build an “API Contract Guard” using Postman’s new AI agent templates. This agent would solve the common web development headache of frontend-backend API contract drift.


The Problem It Solves

Web development often suffers from API discrepancies: frontend expects one thing, backend delivers another. This leads to frustrating bugs, wasted time, and delayed releases. My agent will proactively catch these mismatches, ensuring smooth integration.


How It Would Work (Using Postman AI Agent Templates)

My “API Contract Guard” would primarily use the “AI text toolkit” template for intelligent comparisons.

  1. Trigger: The agent runs automatically when an API is deployed or its specification (like an OpenAPI file) is updated in Git.
  2. Data Fetching:
  • It fetches the latest API specification (the documented contract).
  • It then makes calls to the live backend API for all endpoints, capturing actual responses. To make these requests robust, it would creatively use the AI’s capabilities to generate diverse input data based on the spec (similar to “Generate fake test data” concepts).
  1. AI-Powered Comparison (Using “AI text toolkit”):
  • The core here is the “AI text toolkit.” It takes the documented API schema and the actual live API responses.
  • The AI compares them, flagging discrepancies like:
    • Schema Mismatches: Missing or extra fields, incorrect data types.
    • Parameter Drift: Documented parameters not supported, or new ones undocumented.
    • Example Consistency (Quirky): If the documentation has example responses, the AI checks if the live API’s actual response matches the documented example, catching even subtle, confusing differences.
    • Semantic Drift (Unexpected): The AI can even analyze field descriptions against actual data to flag if a field’s purpose has subtly changed (e.g., “user_status” now returning “payment_processing” values).
  1. Automated Reporting:
  • When discrepancies are found, the agent generates a clear report.
  • This report is automatically posted to a Slack channel (like the “Log incident updates from Slack” idea), alerting teams immediately.
  • It can also create a Jira ticket (similar to “Create tickets from Slack”), assigning it to the relevant team with all details and AI-suggested fixes.

Postman Notebook for Visibility & Control

The entire system would be controlled and visualized through a Postman Notebook for the bonus giveaway.

  • Setup: Easy input fields for API URLs, Slack webhooks, and Jira details.
  • “Run Audit” Button: A single click triggers the agent.
  • Interactive Results: The Notebook would display:
    • A summary of findings (e.g., “5 schema mismatches”).
    • Detailed reports for each issue, showing documented vs. actual values and AI’s explanation/fix suggestions.
    • A “Contract Health Score” (a quirky visual meter) to gamify maintaining a healthy API contract.
    • Links directly to any created Jira tickets.

This “API Contract Guard” empowers web developers by automating tedious contract validation, freeing them to build features faster and with greater confidence.

2 Likes

:trophy: Challenge Winner!

Big congrats to @satellite-meteorolo4 for their creative idea to build an agent that keeps API documentation in sync with code using the Industry News Updates and Analysis agent from the AI agent templates. This solution solves a problem that many development teams face with keeping API documentation up to date as the code evolves.

We loved the clarity and creativity in their response, plus the real-world value.

The next 24-hour challenge drops on Wednesday. Be ready!

3 Likes

Also using this opportunity to encourage everyone who submitted a Notebook to participate in the Postman Notebooks Challenge. You can make multiple entries, and your Notebook submission for this challenge is a valid entry as well!

2 Likes

@satellite-meteorolo4 is far too kind :heart:. He has volunteered to have the second runner up, @technical-explorer-8, to get his $150 reward for this challenge. This is incredibly beautiful and thoughtful of him, and is an example of what a healthy community should look like. Drop a heart( :heart:) if you agree.

5 Likes