main

Update Workflow

Changed on

Update an existing workflow.

Args: workflow_id: The ID of the workflow to update request: The update request containing the new name and workflow definition

Returns: The updated workflow

Raises: HTTPException: If the workflow is not found or if there's a database error

put/api/v1/workflow/{workflow_id}

Request

  • Base URL
    https://app.dograh.com
  • URL
    https://app.dograh.com/api/v1/workflow/{workflow_id}
  • Auth
    none declared

Path parameters

workflow_idinteger required

Headers

authorizationstring nullable
X-API-Keystring nullable

Request body

namestring nullable
workflow_definitionobject nullable
template_context_variablesobject nullable

Response

Successful Response

idinteger required
namestring required
statusstring required
created_atstring date-time required
workflow_definitionobject required
current_definition_idinteger nullable required
template_context_variablesobject nullable
total_runsinteger nullable
workflow_configurationsobject nullable
version_numberinteger nullable
version_statusstring nullable
workflow_uuidstring nullable

Changes

    • breaking

      removed the enum value provisional_vad of the request property //

    • warning

      the // request property's min was set to 1.00

    • warning

      removed the request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request property default value changed from 3 to 2

    • info

      the request property default value changed from default to min_words