API Access

Published workflows can be accessed programmatically through API keys. This lets external systems, scripts, or applications execute workflows and retrieve results without using the Kogenta Connect interface.

Generating API keys

To create an API key for a published workflow:

1. Open the workflow
2. Navigate to the API keys section
3. Generate a new API key
4. Copy and securely store the key - it will only be shown once

Each API key is scoped to a specific workflow.

Using the API

With an API key, you can send requests to execute a workflow and retrieve results. The API accepts parameter values as part of the request, just like providing parameters through the interface.

A typical API request includes:

• The workflow identifier
• The API key for authentication
• Parameter values (if the workflow has parameters)

The response contains the query results in a structured format that your application can process.

When to use API access

API access is useful for:

• Integrating with other tools - pull workflow results into BI tools, reporting systems, or custom applications
• Automating data pipelines - trigger workflow execution from scripts or scheduled jobs
• Embedding data - fetch results to display in external websites or applications

Security

• API keys should be treated as secrets - do not share them publicly or commit them to version control
• Each key is tied to a specific workflow and organization
• Keys can be revoked at any time if compromised