About the Flow Graph Engine API
The Flow Graph Engine API lets developers run compute jobs on data that is stored on the cloud. The API enables cloud-based workflows to asynchronously execute long, complex and repetitive compute operations, leveraging the available executors.
The Job set of APIs is used to submit jobs, as well as to monitor and control them. This API also provides information about which outputs and logs have been produced by jobs.
The Resource set of APIs is used to store input data that will be used as inputs when submitting tasks in the job API as well as retrieving outputs and logs once a task has finished executing.
With the Flow Graph Engine APIs, you can programmatically access compute capabilities provided by executors. Currently you can access the Bifrost executor, which is used by Maya artists and TDs to create complex effects like simulation. More executors will be added in the future.
Different compute capabilities have different job requirements. When submitting a job to the Flow Graph Engine Job API, the description of each task is therefore divided into a generic part that is the same regardless of what executor will process it, and an executor-specific section.
More information can be found in Submitting a job.
To retrieve outputs and logs, use the Resource API. This API provide presigned URLs that can be used to retrieve the data. This API is also used to upload input data to the scratch space. The scratch space is a default per-user temporary storage space provided by the API.
More information can be found in Handling resources.
Common Uses
The Flow Graph Engine APIs are best suited for:
- Executing repetitive computation tasks
- Offloading long running computation to free local resources
- Parallelizing many jobs/tasks
Different executors can be used to create different solutions.
Executor | Used for |
---|---|
Bifrost | Create complex effects, run simulations, manipulate 3d models, scatter objects and more. |
Next Steps
- Explore Code Samples to discover how the API is used in a fully functional application.
Terms of Service
Flow graph Engine API is subject to Autodesk Platform Services Terms of Service.