Skip to content

aiprotocols/spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 

Repository files navigation

AI Protocols Spec

The canonical specification for AI Protocols — a unified standard for interacting with AI models across providers and languages.

🧠 Overview

AI Protocols defines a consistent, language-agnostic interface for:

  • Sending requests to AI models
  • Receiving structured responses
  • Streaming outputs in real-time
  • Defining and executing tools/functions
  • Managing conversation state and metadata

This repository contains the canonical JSON Schema definitions, along with documentation and examples.

📦 Repository Structure

schema/     → JSON Schema definitions (source of truth)
docs/       → Human-readable documentation for each schema
examples/   → Example payloads and usage patterns

🧩 Specification Structure

Core Schemas

📚 Documentation

Each schema is fully documented:

⚡ Examples

Real-world usage examples:

examples/

🎯 Design Principles

Provider-agnostic

Abstracts differences between AI providers into a unified format.

Language-agnostic

JSON Schema enables generation of types and models across ecosystems.

Streaming-first

A unified event-based streaming protocol across all providers.

Tool-native

Standardized function/tool calling interface.

Conversation-aware & observable

Supports structured context through:

  • conversation_id
  • context_key

🛣 Versioning

  • v0.x — experimental, subject to breaking changes
  • v1.0 — stable contract

⚠️ Status

This specification is in early development (v0.x). Breaking changes are expected until v1.0.

🤝 Contributing

Contributions are welcome.

Before contributing:

  • Follow existing schema structure
  • Keep changes provider-agnostic
  • Update documentation and examples alongside schema changes

📜 License

MIT

About

The specification for AI Protocols.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors