The Arazzo Specification defines a standard, programming language-agnostic mechanism for expressing deterministic API workflows and their dependencies. It targets developers and API providers/consumers, aiming to simplify complex API interactions and enable automated documentation, code generation, and AI-driven API invocation.

How It Works

Arazzo allows users to define sequences of API calls and their interdependencies, similar to how OpenAPI describes HTTP interfaces. This specification enables the articulation of functional use cases offered by one or more APIs, removing ambiguity for both human and machine consumers. The approach is designed to be human-readable and machine-readable, facilitating deterministic execution of API workflows.

Quick Start & Requirements

• Installation: No specific installation instructions are provided in the README, as this is a specification document. Implementations would require separate installation.
• Prerequisites: Requires API descriptions, such as those in the OpenAPI Specification.
• Resources: No specific resource requirements are listed.
• Links:
  • Arazzo Specification - latest: https://github.com/OAI/Arazzo-Specification/blob/main/Arazzo.yaml
  • Examples: https://github.com/OAI/Arazzo-Specification/tree/main/examples

Highlighted Details

• Community-driven specification under the OpenAPI Initiative.
• Enables deterministic API invocation by AI-based LLMs.
• Facilitates automated documentation generation and SDK creation.
• Supports both design-first and code-first development processes.

Maintenance & Community

• Active community participation encouraged via bi-weekly calls, GitHub discussions, and a Slack channel.
• Slack: https://join.slack.com/t/openapi-slack/shared_invite/zt-1j19f039p-h07j0682100f3f1090309g

Licensing & Compatibility

• License: Apache-2.0.
• Compatibility: Permissive license suitable for commercial use and integration with closed-source projects.

Limitations & Caveats

This repository contains the specification itself, not an implementation. Users will need to find or build tools that consume and execute Arazzo workflow definitions. The specification is still evolving within the OpenAPI Initiative.