API guide
This article explains the available API types in Autify Genesis, how to use them, and their limitations.
API key management
For creating, checking, and deleting API keys, see API key management.
Triggering a workflow via API
To trigger a workflow from an external application or program, enable API access.
Use the following steps to enable the setting and check the endpoint.
1. Opening the workflow editor
Open the editor for the workflow that you want to trigger via API.
2. Opening the trigger settings menu
At the top of the screen, click More actions, then click Triggers in the menu.

3. Enabling API access
By default, API access is set to OFF.
Turn the API access switch to ON.
Under Concurrency, choose how Genesis should handle a new API request while an earlier API-triggered run of the same workflow is still pending or running.
Run in parallel
Start the new run and keep the earlier run going
Cancel previous executions
Cancel older pending or running API-triggered runs of the same workflow, then start the new run
4. Checking the API endpoint
When API access is ON, the dedicated API endpoint is shown.

Endpoint format:
https://genesis.autify.com/api/workflows/{templateId}/trigger
REST API
Using an API key, you can trigger Genesis workflows from external systems and check their execution status.
Triggering a workflow
Endpoint
Request headers
x-api-key
Issued API key
Required
Content-Type
application/json
Recommended
Request body
Specify the context variables defined in the workflow as key-value pairs in JSON.
Response (success)
Use the returned executionId to check execution status.
Request example (curl)
Getting execution status
Endpoint
Request headers
x-api-key
Issued API key
Required
Request example (curl)
Response example (success)
Execution status values
pending
Waiting to run
running
Running
completed
Completed
failed
Failed
cancelled
Cancelled
skipped
Skipped by a condition
review_pending
Waiting for review
Troubleshooting
Authentication errors
Missing API key (401)
The x-api-key header is missing
Add the x-api-key header
Invalid API key (401)
The API key is invalid or does not exist
Verify that you are using a valid API key
API key is not associated with an organization (403)
The API key is not linked to an organization
Recreate a valid API key
Unauthorized (403)
The user for the API key is not a member of the target organization
Use an API key issued by a member of that organization
API key does not have access to this organization (403)
The API key's organization does not match the workflow's organization
Use an API key issued in the same organization
Payload errors
Invalid JSON payload (400)
The request body is not valid JSON
Check the JSON syntax
Payload too large (413)
The payload exceeds 10 MB
Keep the payload size under 10 MB
Invalid payload: expected object with string values (500)
A payload value is not a string (number, array, etc.)
Use string values for all fields
Unexpected fields in payload (500)
The payload contains a key that is not defined in the workflow
Update the keys to match the workflow's context variables
Resource errors
Workflow template not found or API access not enabled (404)
The template ID does not exist, or the API trigger is disabled
Verify the template ID, or enable API access in the workflow settings
Invalid template ID (400)
The template ID is not in UUID format
Use a valid template ID
Usage limit reached (403)
The organization has reached its credit limit
Ask an administrator to add credits
Workflow template must belong to a project (400)
The template is not linked to a project
Link the template to an existing project
Project not found (404)
The project linked to the template does not exist
Check the project settings
Execution not found (404)
No execution exists for the specified executionId
Verify that the executionId is valid
Last updated