Skip to main content

📜 FTAI — Foundational Traceable AI Interface

License: Apache 2.0 CI


FTAI is a hybrid format for human–AI collaboration, designed to improve on JSON, Markdown, and YAML for AI-native workflows with a structured, minimal, human-readable protocol.

Built for serious AI developers, researchers, and agent architects — but accessible enough for new builders learning to speak to machines.


🚀 Why FTAI?

  • Readable by humans. Parseable by models.
  • Deterministic: Always yields the same structure across systems.
  • Traceable: Embeds rationale, constraints, and memory scopes directly.
  • Composable: Bridges cleanly into JSON, YAML, text embeddings, or pipelines.
  • Minimal: No noisy punctuation, no nested spaghetti.
  • Multimodal: Native support for image references and vision-capable models.

FTAI is Markdown for agents. JSON for intelligence. YAML for reasoning.


🖼️ Multimodal Support

FTAI natively handles image references for vision-capable AI models:

@image
  src: ./screenshot.png
  alt: Application dashboard
  context: User is asking about the error shown in the top-right

@task
  analyze the image and identify the error message
@end

Images can be:

  • Local file paths
  • Base64 encoded inline
  • URLs (when online processing is available)

This makes FTAI ideal for workflows involving screenshots, documents, diagrams, and visual context.


📦 Install

From PyPI (Recommended)

pip install ftai-py

From Source

git clone https://github.com/FolkTechAI/ftai-spec.git
cd ftai-spec
pip install -e .

⚡ Quick Start

# Lint an FTAI file
ftai lint myfile.ftai

# Lint with strict mode
ftai lint myfile.ftai --strict

# Lint with lenient mode (unknown tags as warnings)
ftai lint myfile.ftai --lenient

# Convert JSON to FTAI
ftai convert data.json > output.ftai

# Check version
ftai --version

🛠 What's Inside

File/Directory Purpose
src/ftai_linter/ Python package with CLI and linter
grammar/ftai.ebnf Formal syntax definition (EBNF)
grammar/FTAI_grammar_syntax_v1.6.md Human-readable grammar spec
parsers/swift/ Swift parser implementation
tests/vectors/pass/ Valid FTAI examples
tests/vectors/fail/ Invalid FTAI examples (for testing)
tools/json_to_ftai.py JSON → FTAI converter
spec/example/ Real-world FTAI examples

📝 Basic Syntax

@ftai v2.0 lang:en

@document
  title: "My First FTAI Document"
  author: "Your Name"
  created: 2026-01-09

@section Introduction
  This is a simple FTAI document demonstrating the format.

@task priority:high
  description: Review the quarterly report
  due: 2026-01-15
@end

@note
  Remember to check the appendix for supporting data.

Core Tags

Tag Purpose
@ftai Document header (required)
@document Document metadata (required)
@section Content section
@task Actionable task (requires @end)
@note Informational note
@warning Important warning
@config Configuration block (requires @end)
@memory Memory/context block (requires @end)
@image Image reference (multimodal)
@table Tabular data

🤝 Contributing

We welcome thoughtful contributors! All Pull Requests require signing our Contributor License Agreement (CLA) first.

Local Development

git clone https://github.com/FolkTechAI/ftai-spec.git
cd ftai-spec
pip install -e .
pip install pytest

# Run tests
pytest tests/ -v

# Test the CLI
ftai lint tests/vectors/pass/pass_minimal.ftai

🛡 License & Governance

FTAI is stewarded with transparent, reviewable releases — designed for long-term stability, not churn.


🌱 Built in the Open

FTAI is designed for the future of machine interaction: clear enough for a person, structured enough for a model, powerful enough for autonomous systems.

Built openly by FolkTech AI with contributions from the community.


© 2025-2026 FolkTech AI — Format maintained by Michael Folk and contributors.

Metadata

Release files for ftai 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ftai 1.0.0
File Size Uploaded Provenance Actions
ftai-1.0.0.tar.gz 12.2 kB With provenance Details for ftai-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ftai 1.0.0
File Interpreter ABI Platform Actions
ftai-1.0.0-py3-none-any.whl Python 3 none any Details for ftai-1.0.0-py3-none-any.whl

Total release size: 24.3 kB

Release files / ftai-1.0.0.tar.gz

Download URL ftai-1.0.0.tar.gz
Size 12.2 kB
Tags Source
SHA-256 checksum
How to use checksums
aecf32ef3b40be3bcc5f3f42825e5c86dcc489b8b05abdade4704d144b0fff7b
BLAKE2b-256 checksum
How to use checksums
e27964a89ee2d4c96f2b2e73ae4260614edceaa8aad8d35c6844c824765c63f6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jan 10, 2026.

Transparency log

Release files / ftai-1.0.0-py3-none-any.whl

Download URL ftai-1.0.0-py3-none-any.whl
Size 12.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1bd6f4a75363935e534e77ca74cc88c63a276d5135ce3b3b0aade3abac042271
BLAKE2b-256 checksum
How to use checksums
0e74e66c8011fd94b64b7550d2c8bf0fa73198409a9ded1e7f2b8307bae49521
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jan 10, 2026.

Transparency log

Security for ftai 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for ftai-1.0.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jan 10, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page