telepact-api

Model Telepact schemas as type-safe definitions for API design.

2|3|Updated Mar 22, 2025
One-click install
npx skills add https://github.com/Telepact/telepact --skill telepact-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: telepact-api
Source: https://github.com/Telepact/telepact/tree/main/skills/telepact-api
Command: npx skills add https://github.com/Telepact/telepact --skill telepact-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Telepact API design and tooling helps teams define, validate, and deploy consistent, type-safe API schemas across languages and runtimes.

Core Features & Use Cases

  • Schema-driven API development with example-driven guidance for Typescript, Python, Java, and Go libraries.
  • Tools and docs for writing, testing, and mocking Telepact APIs, including CLI, Console, and Prettier plugin integration.
  • Real-world workflows for serving, testing, and evolving APIs across teams and stacks.

Quick Start

Install Telepact, define your API schema using the Telepact JSON format, and run a server that serves the defined API.

Frequently Asked Questions about telepact-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I define and validate a type-safe API schema?

You can define and validate a type-safe API schema by modeling it as structured Telepact JSON definitions, which enforces frontmatter presence and section requirements to ensure consistency for discovery and tooling.

Does Telepact API tooling support schema-driven development for Python and Go libraries?

Yes, Telepact API tooling supports schema-driven development by providing example-driven guidance and tooling for Typescript, Python, Java, and Go libraries to help teams write and test APIs.

What is the best way to draft and deploy APIs consistently across different languages?

The best way to draft and deploy APIs consistently is by using a schema-driven approach that models structured definitions and enforces consistent metadata extraction across multiple languages and runtimes.

Can I use Telepact APIs with my existing CLI, Console, and Prettier plugin workflow?

Yes, you can integrate Telepact APIs into your existing workflow as it provides specific tools and documentation for writing, testing, and mocking APIs including CLI, Console, and Prettier plugin integration.

How do I start serving an API after defining the schema?

To start serving an API, install Telepact, define your API schema using the Telepact JSON format, and then run a server that serves the defined API using the provided tooling.