openapi: 3.1.0 info: title: Fyrn API version: '2026-10-18' description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-18: 94 operation(s) read from 1 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Fyrn has published no machine-readable contract that the pipeline could find. Engine: local.' x-evidence-tiers: code-example: 0 documentation: 94 pages-with-code: 0 pages-read: 1 x-generated-from: documentation x-provenance: generated x-authored-by: API Evangelist x-generated: '2026-10-18' x-generator: generate-contract-from-docs.py x-engine: local x-sources: - https://docs.fyrn.ai/reference/api-reference servers: - url: https://api.fyrn.dev/api/v1 paths: /api/v1/adapters: get: operationId: get_api_v1_adapters tags: - Api summary: List all adapters. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) x-evidence: kind: documentation post: operationId: post_api_v1_adapters tags: - Api summary: Create an adapter. x-source: https://docs.fyrn.ai/reference/api-reference responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/adapters/{id}: delete: operationId: delete_api_v1_adapters_id tags: - Api summary: Soft-delete an adapter. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation get: operationId: get_api_v1_adapters_id tags: - Api summary: Get an adapter by ID. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation put: operationId: put_api_v1_adapters_id tags: - Api summary: Update an adapter. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/adapters/{id}/test: post: operationId: post_api_v1_adapters_id_test tags: - Api summary: Test an adapter with sample input. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiV1AdaptersIdTestRequest' responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/agent-actions: get: operationId: get_api_v1_agent_actions tags: - Api summary: List pending agent actions awaiting approval. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/agent-actions/{id}/approve: post: operationId: post_api_v1_agent_actions_id_approve tags: - Api summary: Approve a pending agent action. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/agent-actions/{id}/reject: post: operationId: post_api_v1_agent_actions_id_reject tags: - Api summary: Reject a pending agent action. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/agent-keys: get: operationId: get_api_v1_agent_keys tags: - Api summary: List agent API keys for MCP access. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) x-evidence: kind: documentation post: operationId: post_api_v1_agent_keys tags: - Api summary: Create an agent API key. x-source: https://docs.fyrn.ai/reference/api-reference responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/agent-keys/{id}: delete: operationId: delete_api_v1_agent_keys_id tags: - Api summary: Deactivate an agent key. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/ai/analyze-error: post: operationId: post_api_v1_ai_analyze_error tags: - Api summary: Analyze a flow error and suggest fixes (self-healing). description: Analyze a flow error and suggest fixes (self-healing). x-source: https://docs.fyrn.ai/reference/api-reference responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/ai/generate-adapter: post: operationId: post_api_v1_ai_generate_adapter tags: - Api summary: Generate adapter JavaScript code from a description. description: Generate adapter JavaScript code from a description. x-source: https://docs.fyrn.ai/reference/api-reference requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiV1AiGenerateAdapterRequest' responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/ai/generate-flow: post: operationId: post_api_v1_ai_generate_flow tags: - Api summary: Generate a flow YAML from a natural language description. description: Generate a flow YAML from a natural language description. x-source: https://docs.fyrn.ai/reference/api-reference requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiV1AiGenerateFlowRequest' responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/ai/generate-published-api: post: operationId: post_api_v1_ai_generate_published_api tags: - Api summary: Generate a published API configuration from a description. description: Generate a published API configuration from a description. x-source: https://docs.fyrn.ai/reference/api-reference responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/ai/generate-test-payload: post: operationId: post_api_v1_ai_generate_test_payload tags: - Api summary: Generate a realistic test payload for a flow. description: Generate a realistic test payload for a flow. x-source: https://docs.fyrn.ai/reference/api-reference responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/alert-channels: get: operationId: get_api_v1_alert_channels tags: - Api summary: List alert channels. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) x-evidence: kind: documentation post: operationId: post_api_v1_alert_channels tags: - Api summary: Create an alert channel. x-source: https://docs.fyrn.ai/reference/api-reference responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/alert-history: get: operationId: get_api_v1_alert_history tags: - Api summary: List alert history. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/alert-rules: get: operationId: get_api_v1_alert_rules tags: - Api summary: List alert rules. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) x-evidence: kind: documentation post: operationId: post_api_v1_alert_rules tags: - Api summary: Create an alert rule. x-source: https://docs.fyrn.ai/reference/api-reference responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/alert-rules/{id}: put: operationId: put_api_v1_alert_rules_id tags: - Api summary: Update an alert rule. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/audit-log: get: operationId: get_api_v1_audit_log tags: - Api summary: List audit log entries. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: action in: query required: false schema: type: string - name: entityType in: query required: false schema: type: string - name: entityId in: query required: false schema: type: string - name: userId in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer - name: offset in: query required: false schema: type: integer responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/auth/me: get: operationId: get_api_v1_auth_me tags: - Api summary: Get the current authenticated user’s profile. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/batch: get: operationId: get_api_v1_batch tags: - Api summary: List recent batch jobs. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: flowId in: query required: false schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation post: operationId: post_api_v1_batch tags: - Api summary: Start a batch job. x-source: https://docs.fyrn.ai/reference/api-reference requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiV1BatchRequest' responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/batch/{id}: get: operationId: get_api_v1_batch_id tags: - Api summary: Get batch job status and progress. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/batch/{id}/errors: get: operationId: get_api_v1_batch_id_errors tags: - Api summary: Export batch job errors. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/batch/{id}/retry: post: operationId: post_api_v1_batch_id_retry tags: - Api summary: Retry failed records in a batch job. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/connectors/catalog: get: operationId: get_api_v1_connectors_catalog tags: - Api summary: List all connector catalog entries. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/connectors/catalog/{catalogid}/actions: get: operationId: get_api_v1_connectors_catalog_catalogid_actions tags: - Api summary: List actions for a catalog entry. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: catalogid in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/connectors/catalog/{catalogid}/actions/{slug}: get: operationId: get_api_v1_connectors_catalog_catalogid_actions_slug tags: - Api summary: Get a specific action with full request/response schemas. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: catalogid in: path required: true schema: type: string - name: slug in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/connectors/instances: get: operationId: get_api_v1_connectors_instances tags: - Api summary: List connector instances for the current environment. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) x-evidence: kind: documentation post: operationId: post_api_v1_connectors_instances tags: - Api summary: Create a new connector instance. x-source: https://docs.fyrn.ai/reference/api-reference requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiV1ConnectorsInstancesRequest' responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/connectors/instances/{id}: delete: operationId: delete_api_v1_connectors_instances_id tags: - Api summary: Soft-delete a connector instance. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation get: operationId: get_api_v1_connectors_instances_id tags: - Api summary: Get a single connector instance (config fields redacted). x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation put: operationId: put_api_v1_connectors_instances_id tags: - Api summary: Update a connector instance. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/connectors/instances/{id}/schemas: get: operationId: get_api_v1_connectors_instances_id_schemas tags: - Api summary: List tracked endpoint schemas for a connector instance. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/connectors/instances/{id}/schemas/check: post: operationId: post_api_v1_connectors_instances_id_schemas_check tags: - Api summary: Trigger a schema check for a connector instance. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/connectors/instances/{id}/test: post: operationId: post_api_v1_connectors_instances_id_test tags: - Api summary: Test a connector instance connection. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/connectors/oauth/authorize: get: operationId: get_api_v1_connectors_oauth_authorize tags: - Api summary: Start OAuth flow for a connector. Returns the authorization URL. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: catalogId in: query required: false schema: type: string - name: instanceName in: query required: false schema: type: string - name: redirectUri in: query required: false schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/environments: get: operationId: get_api_v1_environments tags: - Api summary: List environments for the current account. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) x-evidence: kind: documentation post: operationId: post_api_v1_environments tags: - Api summary: Create an environment. x-source: https://docs.fyrn.ai/reference/api-reference responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/environments/{id}: put: operationId: put_api_v1_environments_id tags: - Api summary: Update an environment. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/flows: get: operationId: get_api_v1_flows tags: - Api summary: List all flows for the current environment. Webhook-triggered flows include their full webhook URL. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) content: application/json: schema: $ref: '#/components/schemas/GetApiV1FlowsResponse' x-evidence: kind: documentation post: operationId: post_api_v1_flows tags: - Api summary: Create a new flow. x-source: https://docs.fyrn.ai/reference/api-reference requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiV1FlowsRequest' responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/flows/{id}: delete: operationId: delete_api_v1_flows_id tags: - Api summary: Soft-delete a flow. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation get: operationId: get_api_v1_flows_id tags: - Api summary: Get a single flow by ID. Returns full flow object including parsed config and compiled plan. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation put: operationId: put_api_v1_flows_id tags: - Api summary: Update a flow. Accepts name , description , yamlConfig , status , changeSummary . x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/PutApiV1FlowsIdRequest' responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/flows/{id}/deploy: post: operationId: post_api_v1_flows_id_deploy tags: - Api summary: Deploy a flow — validates, compiles, activates, and creates a version snapshot. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) content: application/json: schema: $ref: '#/components/schemas/PostApiV1FlowsIdDeployResponse' x-evidence: kind: documentation /api/v1/flows/{id}/export: post: operationId: post_api_v1_flows_id_export tags: - Api summary: Export a flow as a ZIP bundle (YAML config, lookup tables, adapter code). x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/flows/{id}/pause: post: operationId: post_api_v1_flows_id_pause tags: - Api summary: Pause an active flow. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/flows/{id}/promote: post: operationId: post_api_v1_flows_id_promote tags: - Api summary: Promote a flow from one environment to another. description: Promote a flow from one environment to another. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiV1FlowsIdPromoteRequest' responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/flows/{id}/resume: post: operationId: post_api_v1_flows_id_resume tags: - Api summary: Resume a paused flow. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/flows/{id}/rollback: post: operationId: post_api_v1_flows_id_rollback tags: - Api summary: Rollback to a previous version. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiV1FlowsIdRollbackRequest' responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/flows/{id}/test: post: operationId: post_api_v1_flows_id_test tags: - Api summary: Test a flow with sample data. Applies the mapping without delivery. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiV1FlowsIdTestRequest' responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/flows/{id}/versions: get: operationId: get_api_v1_flows_id_versions tags: - Api summary: List version history for a flow. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/flows/{id}/visualize: post: operationId: post_api_v1_flows_id_visualize tags: - Api summary: Get the execution plan as a directed graph for the pipeline visualizer. description: Get the execution plan as a directed graph for the pipeline visualizer. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/flows/import: post: operationId: post_api_v1_flows_import tags: - Api summary: Import a flow from a ZIP bundle. x-source: https://docs.fyrn.ai/reference/api-reference requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiV1FlowsImportRequest' responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/healing: get: operationId: get_api_v1_healing tags: - Api summary: List healing events. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: flowId in: query required: false schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/healing/{id}: get: operationId: get_api_v1_healing_id tags: - Api summary: Get a healing event by ID. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/healing/{id}/approve: post: operationId: post_api_v1_healing_id_approve tags: - Api summary: Approve a pending healing fix. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/healing/{id}/reject: post: operationId: post_api_v1_healing_id_reject tags: - Api summary: Reject a pending healing fix. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/lookup-tables: get: operationId: get_api_v1_lookup_tables tags: - Api summary: List all lookup tables. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) x-evidence: kind: documentation post: operationId: post_api_v1_lookup_tables tags: - Api summary: Create a lookup table. x-source: https://docs.fyrn.ai/reference/api-reference requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiV1LookupTablesRequest' responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/lookup-tables/{id}: delete: operationId: delete_api_v1_lookup_tables_id tags: - Api summary: Soft-delete a lookup table. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation get: operationId: get_api_v1_lookup_tables_id tags: - Api summary: Get a lookup table with entries. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/lookup-tables/{id}/entries: put: operationId: put_api_v1_lookup_tables_id_entries tags: - Api summary: Add or update an entry. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PutApiV1LookupTablesIdEntriesRequest' responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/lookup-tables/{id}/entries/{key}: delete: operationId: delete_api_v1_lookup_tables_id_entries_key tags: - Api summary: Delete an entry by key. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string - name: key in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/lookup-tables/{id}/export: get: operationId: get_api_v1_lookup_tables_id_export tags: - Api summary: Export entries as CSV. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/lookup-tables/{id}/import: post: operationId: post_api_v1_lookup_tables_id_import tags: - Api summary: Import entries from CSV. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiV1LookupTablesIdImportRequest' responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/members: get: operationId: get_api_v1_members tags: - Api summary: List account members with roles. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/members/{id}: put: operationId: put_api_v1_members_id tags: - Api summary: Update a member’s role. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PutApiV1MembersIdRequest' responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/members/invite: post: operationId: post_api_v1_members_invite tags: - Api summary: Invite a user to the account. x-source: https://docs.fyrn.ai/reference/api-reference requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiV1MembersInviteRequest' responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/messages: get: operationId: get_api_v1_messages tags: - Api summary: List messages for a flow. description: List messages for a flow. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: flowId in: query required: true schema: type: string - name: status in: query required: false schema: type: string - name: since in: query required: false schema: type: string - name: search in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer - name: offset in: query required: false schema: type: integer responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/messages/{id}: get: operationId: get_api_v1_messages_id tags: - Api summary: Get a single message with full trace. description: Get a single message with full trace. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/messages/{id}/replay: post: operationId: post_api_v1_messages_id_replay tags: - Api summary: Replay a message through the full pipeline. description: Replay a message through the full pipeline. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/messages/{id}/retry: post: operationId: post_api_v1_messages_id_retry tags: - Api summary: Retry a failed message. description: Retry a failed message. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/published-apis: get: operationId: get_api_v1_published_apis tags: - Api summary: List published API endpoints. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) x-evidence: kind: documentation post: operationId: post_api_v1_published_apis tags: - Api summary: Create a published API. x-source: https://docs.fyrn.ai/reference/api-reference responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/published-apis/{id}: delete: operationId: delete_api_v1_published_apis_id tags: - Api summary: Soft-delete a published API. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation get: operationId: get_api_v1_published_apis_id tags: - Api summary: Get a published API by ID. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation put: operationId: put_api_v1_published_apis_id tags: - Api summary: Update a published API. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/published-apis/{id}/keys: get: operationId: get_api_v1_published_apis_id_keys tags: - Api summary: List consumer keys. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation post: operationId: post_api_v1_published_apis_id_keys tags: - Api summary: Create a consumer API key. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/published-apis/{id}/keys/{keyid}: delete: operationId: delete_api_v1_published_apis_id_keys_keyid tags: - Api summary: Revoke a consumer key. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string - name: keyid in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/published-apis/{id}/versions: get: operationId: get_api_v1_published_apis_id_versions tags: - Api summary: List API versions. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/schedules: get: operationId: get_api_v1_schedules tags: - Api summary: List all schedules. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: flowId in: query required: false schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/schedules/{id}: put: operationId: put_api_v1_schedules_id tags: - Api summary: Update a schedule — cron expression, timezone, enabled. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation /api/v1/schedules/{id}/trigger: post: operationId: post_api_v1_schedules_id_trigger tags: - Api summary: Manually trigger a scheduled flow. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: id in: path required: true schema: type: string responses: '201': description: Success (status as documented) x-evidence: kind: documentation /api/v1/search: get: operationId: get_api_v1_search tags: - Api summary: Full-text search across flows, connectors, adapters, and published APIs. x-source: https://docs.fyrn.ai/reference/api-reference parameters: - name: q in: query required: false schema: type: string - name: type in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer responses: '200': description: Success (status as documented) x-evidence: kind: documentation /health: get: operationId: get_health tags: - Health summary: Health check endpoint. No auth required. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) content: application/json: schema: $ref: '#/components/schemas/GetHealthResponse' x-evidence: kind: documentation /oauth/callback: get: operationId: get_oauth_callback tags: - Oauth summary: OAuth callback handler. Exchanges authorization code for tokens. x-source: https://docs.fyrn.ai/reference/api-reference responses: '200': description: Success (status as documented) x-evidence: kind: documentation components: schemas: PostApiV1AdaptersIdTestRequest: type: object properties: input: type: string description: Sample input for testing. required: - input PostApiV1AiGenerateAdapterRequest: type: object properties: description: type: string adapterType: type: string sampleInput: type: object required: - description - adapterType PostApiV1AiGenerateFlowRequest: type: object properties: description: type: string sourceHint: type: string targetHint: type: string errorHandling: type: string required: - description PostApiV1BatchRequest: type: object properties: flowId: type: string records: type: array concurrency: type: integer required: - flowId - records PostApiV1ConnectorsInstancesRequest: type: object properties: catalogId: type: string name: type: string displayName: type: string config: type: string required: - catalogId - name - displayName - config GetApiV1FlowsResponse: type: object properties: id: type: string name: type: string status: type: string version: type: integer description: type: string yamlConfig: type: string webhookUrl: type: string PostApiV1FlowsRequest: type: object properties: name: type: string description: type: string yamlConfig: type: string required: - name - description - yamlConfig PutApiV1FlowsIdRequest: type: object properties: name: type: string description: type: string yamlConfig: type: string status: type: string changeSummary: type: string PostApiV1FlowsIdDeployResponse: type: object properties: webhookUrl: type: string description: Deployed flow webhook URL if applicable PostApiV1FlowsIdPromoteRequest: type: object properties: targetEnvironmentId: type: string notes: type: string required: - targetEnvironmentId PostApiV1FlowsIdRollbackRequest: type: object properties: versionNumber: type: integer required: - versionNumber PostApiV1FlowsIdTestRequest: type: object properties: sampleData: type: object required: - sampleData PostApiV1FlowsImportRequest: type: object properties: file: type: string description: ZIP file required: - file PostApiV1LookupTablesRequest: type: object properties: name: type: string description: type: string required: - name PutApiV1LookupTablesIdEntriesRequest: type: object properties: key: type: string value: type: string required: - key - value PostApiV1LookupTablesIdImportRequest: type: object properties: CSV file: type: string description: CSV file with key and value columns. required: - CSV file PutApiV1MembersIdRequest: type: object properties: role: type: string required: - role PostApiV1MembersInviteRequest: type: object properties: email: type: string role: type: string required: - email - role GetHealthResponse: type: object properties: status: type: string description: Health status, e.g., "ok" securitySchemes: API_key: type: apiKey in: header name: Authorization x-source: https://docs.fyrn.ai/getting-started/ tags: - name: Api - name: Health - name: Oauth security: - API_key: []