Skip to main content

​
Recipes API Reference

Complete reference for all recipe-related endpoints in the Voyager API.

​
GET /api/v2/organizations//recipeVersions

List recipe versions available to an organization.

​
GET /api/v2/organizations//scanRecipeRevisions

List scan recipe revisions available to an organization.

​
POST /api/v2/projects//runRecipe

Run a recipe on a project.

​
Request Body

{
  "recipePk": "recipe-uuid"
}

​
GET /api/v2/recipeInvocations/

Get recipe invocation details.

​
GET /api/v2/recipeInvocations//results

Get recipe invocation results.

​
Response

{
  "results": [
    {
      "dataObjectId": "uuid",
      "dataObjectFileNames": ["file1.csv", "file2.ply"]
    }
  ],
  "downloadableResults": "https://download-url..."
}
For detailed guides, see Recipes Guide.