API

Expose a FastAPI gateway to trigger and monitor GNN pipeline runs.

30|3|Updated Apr 2, 2023
One-click install
npx skills add https://github.com/ActiveInferenceInstitute/GeneralizedNotationNotation --skill api-activeinferenceinstitute
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: API
Source: https://github.com/ActiveInferenceInstitute/GeneralizedNotationNotation/tree/main/src/api
Command: npx skills add https://github.com/ActiveInferenceInstitute/GeneralizedNotationNotation --skill api-activeinferenceinstitute

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides a local, no-auth REST API gateway to trigger and monitor the Generalized Notation Notation (GNN) processing pipeline from external clients and scripts, enabling programmatic control and integration with tooling.

Core Features & Use Cases

  • Exposes endpoints for health checks, run submission, job polling, tool discovery, and per-step invocation.
  • Supports background execution, in-memory job tracking, and repository-boundary validation to ensure safe, contained runs.
  • Use cases include automation dashboards, integrating the GNN pipeline into CI workflows, and enabling MCP-based tooling to discover and operate pipeline steps.

Quick Start

Start the API server and use the documented endpoints to queue and monitor pipeline runs.

Frequently Asked Questions about API

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

FAQPage Schema
How do I trigger a GNN processing pipeline locally from external scripts?

You can trigger the GNN processing pipeline locally by submitting runs through a no-auth FastAPI gateway, which queues the execution as background tasks and provides endpoints to poll job status.

What is the best way to monitor local job status for REST API pipeline runs?

Monitoring local job status for REST API pipeline runs is handled by polling the dedicated job status endpoint, which retrieves execution updates from the API's in-memory job store.

Can I invoke individual GNN pipeline steps via a local REST API?

Yes, you can invoke individual GNN pipeline steps via the local REST API, which exposes endpoints for per-step tool discovery and execution alongside full run submission.

Does this local API gateway enforce path boundaries for safe pipeline execution?

The local API gateway enforces repository-root path boundaries during pipeline execution, ensuring that all run operations and file accesses remain safely contained within the sandbox environment.

How do I integrate GNN pipeline control with MCP-based tooling?

Integrating GNN pipeline control with MCP-based tooling is achieved by using the API's tool discovery and listing endpoints, allowing MCP clients to programmatically discover and operate individual pipeline steps.

Do I need authentication to submit jobs to the FastAPI processing pipeline?

No authentication is needed to submit jobs to the FastAPI processing pipeline, as the gateway operates without auth requirements to facilitate local automation and CI workflow integration.