# Fyrn API

**Canonical:** https://apis.io/apis/fyrn/fyrn-api/  
**Provider:** Fyrn — https://apis.io/providers/fyrn/  
**Base URL:** https://api.fyrn.dev/api/v1  
**Documentation:** https://docs.fyrn.ai/reference/api-reference

Fyrn API is one of 2 APIs that [Fyrn](https://apis.io/providers/fyrn/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Fyrn API as documented publicly: 94 operations. Contract generated from the documentation by API Evangelist (2026-10-18); not the provider's own document.

## Operations (60 of 94)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/adapters` | List all adapters. |
| POST | `/api/v1/adapters` | Create an adapter. |
| DELETE | `/api/v1/adapters/{id}` | Soft-delete an adapter. |
| GET | `/api/v1/adapters/{id}` | Get an adapter by ID. |
| PUT | `/api/v1/adapters/{id}` | Update an adapter. |
| POST | `/api/v1/adapters/{id}/test` | Test an adapter with sample input. |
| GET | `/api/v1/agent-actions` | List pending agent actions awaiting approval. |
| POST | `/api/v1/agent-actions/{id}/approve` | Approve a pending agent action. |
| POST | `/api/v1/agent-actions/{id}/reject` | Reject a pending agent action. |
| GET | `/api/v1/agent-keys` | List agent API keys for MCP access. |
| POST | `/api/v1/agent-keys` | Create an agent API key. |
| DELETE | `/api/v1/agent-keys/{id}` | Deactivate an agent key. |
| POST | `/api/v1/ai/analyze-error` | Analyze a flow error and suggest fixes (self-healing). |
| POST | `/api/v1/ai/generate-adapter` | Generate adapter JavaScript code from a description. |
| POST | `/api/v1/ai/generate-flow` | Generate a flow YAML from a natural language description. |
| POST | `/api/v1/ai/generate-published-api` | Generate a published API configuration from a description. |
| POST | `/api/v1/ai/generate-test-payload` | Generate a realistic test payload for a flow. |
| GET | `/api/v1/alert-channels` | List alert channels. |
| POST | `/api/v1/alert-channels` | Create an alert channel. |
| GET | `/api/v1/alert-history` | List alert history. |
| GET | `/api/v1/alert-rules` | List alert rules. |
| POST | `/api/v1/alert-rules` | Create an alert rule. |
| PUT | `/api/v1/alert-rules/{id}` | Update an alert rule. |
| GET | `/api/v1/audit-log` | List audit log entries. |
| GET | `/api/v1/auth/me` | Get the current authenticated user’s profile. |
| GET | `/api/v1/batch` | List recent batch jobs. |
| POST | `/api/v1/batch` | Start a batch job. |
| GET | `/api/v1/batch/{id}` | Get batch job status and progress. |
| GET | `/api/v1/batch/{id}/errors` | Export batch job errors. |
| POST | `/api/v1/batch/{id}/retry` | Retry failed records in a batch job. |
| GET | `/api/v1/connectors/catalog` | List all connector catalog entries. |
| GET | `/api/v1/connectors/catalog/{catalogid}/actions` | List actions for a catalog entry. |
| GET | `/api/v1/connectors/catalog/{catalogid}/actions/{slug}` | Get a specific action with full request/response schemas. |
| GET | `/api/v1/connectors/instances` | List connector instances for the current environment. |
| POST | `/api/v1/connectors/instances` | Create a new connector instance. |
| DELETE | `/api/v1/connectors/instances/{id}` | Soft-delete a connector instance. |
| GET | `/api/v1/connectors/instances/{id}` | Get a single connector instance (config fields redacted). |
| PUT | `/api/v1/connectors/instances/{id}` | Update a connector instance. |
| GET | `/api/v1/connectors/instances/{id}/schemas` | List tracked endpoint schemas for a connector instance. |
| POST | `/api/v1/connectors/instances/{id}/schemas/check` | Trigger a schema check for a connector instance. |
| POST | `/api/v1/connectors/instances/{id}/test` | Test a connector instance connection. |
| GET | `/api/v1/connectors/oauth/authorize` | Start OAuth flow for a connector. Returns the authorization URL. |
| GET | `/api/v1/environments` | List environments for the current account. |
| POST | `/api/v1/environments` | Create an environment. |
| PUT | `/api/v1/environments/{id}` | Update an environment. |
| GET | `/api/v1/flows` | List all flows for the current environment. Webhook-triggered flows include their full webhook URL. |
| POST | `/api/v1/flows` | Create a new flow. |
| DELETE | `/api/v1/flows/{id}` | Soft-delete a flow. |
| GET | `/api/v1/flows/{id}` | Get a single flow by ID. Returns full flow object including parsed config and compiled plan. |
| PUT | `/api/v1/flows/{id}` | Update a flow. Accepts name , description , yamlConfig , status , changeSummary . |
| POST | `/api/v1/flows/{id}/deploy` | Deploy a flow — validates, compiles, activates, and creates a version snapshot. |
| POST | `/api/v1/flows/{id}/export` | Export a flow as a ZIP bundle (YAML config, lookup tables, adapter code). |
| POST | `/api/v1/flows/{id}/pause` | Pause an active flow. |
| POST | `/api/v1/flows/{id}/promote` | Promote a flow from one environment to another. |
| POST | `/api/v1/flows/{id}/resume` | Resume a paused flow. |
| POST | `/api/v1/flows/{id}/rollback` | Rollback to a previous version. |
| POST | `/api/v1/flows/{id}/test` | Test a flow with sample data. Applies the mapping without delivery. |
| GET | `/api/v1/flows/{id}/versions` | List version history for a flow. |
| POST | `/api/v1/flows/{id}/visualize` | Get the execution plan as a directed graph for the pipeline visualizer. |
| POST | `/api/v1/flows/import` | Import a flow from a ZIP bundle. |

…and 34 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/fyrn/refs/heads/main/openapi/_ae-authored/fyrn-openapi-generated.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/fyrn/refs/heads/main/json-schema/fyrn-get-api-v1-flows-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/fyrn/refs/heads/main/json-schema/fyrn-post-api-v1-connectors-instances-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/fyrn/refs/heads/main/json-schema/fyrn-post-api-v1-ai-generate-flow-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/fyrn/refs/heads/main/json-schema/fyrn-put-api-v1-flows-id-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/fyrn/refs/heads/main/json-schema/fyrn-post-api-v1-ai-generate-adapter-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/fyrn/refs/heads/main/json-schema/fyrn-post-api-v1-flows-request-schema.json

## Other Fyrn APIs (1)

- [Fyrn REST API](https://apis.io/apis/fyrn/fyrn-rest-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/fyrn/fyrn-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/fyrn/.