Api Reference Guide

What it does

This skill provides a centralized reference for API documentation, allowing AI agents to retrieve and interpret technical specifications for various services. It enables agents to understand endpoint structures, request parameters, and response formats without manual lookup.

When to use it

• When an agent needs to construct valid HTTP requests for external services like Stripe or GitHub.
• To debug integration failures caused by incorrect parameter formatting or missing authentication headers.
• When generating code snippets that interact with specific RESTful or GraphQL APIs.
• For onboarding new agents to a tech stack by providing immediate access to official documentation.

Key capabilities

• Aggregates API reference data from multiple sources into a single queryable format.
• Parses complex documentation structures including schemas, examples, and error codes.
• Supports natural language queries to find specific endpoints or method definitions.

Example prompts

• "Show me the required headers and parameters for creating a new user in the Auth0 API."
• "What is the JSON response structure when a payment fails in the Stripe documentation?"
• "Find the endpoint used to list repositories on GitHub and explain its query parameters."

Tips & gotchas

Ensure the target API has up-to-date public documentation available, as this skill relies on existing reference material. If an API uses private or internal endpoints not documented publicly, this skill may not retrieve the necessary details.