Skip to main content
The APIs list provides a consolidated reference of all APIs available in AI for Process. These APIs enable developers to programmatically perform key operations across the platform, including uploading files, tracking process statuses, and managing workflows and models through actions such as import, export, deployment, and undeployment. All API requests require authentication using an API key, which the account owner or admin can generate from the Settings console.

​
File Management API

Use CasesAPI
Upload a small or large public file in the supported formats.File Upload API

​
View Process Status API

Use CasesAPI
Check the status of an ongoing or completed job related to workflow or models.Get Dock Status API

​
Manage Workflows APIs

Use CasesAPIs
Import a new workflow.Import a New Workflow API
Import new configurations, datasets, or updates into a workflow.Import to an Existing Workflow API
Export a workflow’s configuration and associated data, including its flow, for backup, sharing, or reuse.Export a Workflow API
Deploy a specific workflow into an environment.Deploy a Workflow API
Undeploy a specific workflow from an environment.Undeploy a Workflow API

​
Manage Models APIs

Use CasesAPIs
Import a model in chunks.Import a Model API
Export a trained AI model.Export a Model API
Deploy a model into the environment in the Ready to Deploy state and configure its parameters. You must perform the initial deployment manually in the Platform account. Consecutive deployments must happen via the public API.Deploy a Model API
Undeploy a model from the environment.Undeploy a Model API
Manage external model connections.External Model Connection APIs