MImistral
workflows

Get Workflow Registrations

Changed on

Get Workflow Registrations

get/v1/workflows/registrations

Request

Query parameters

workflow_idstring uuid nullable

The workflow ID to filter by

task_queuestring nullable

The task queue to filter by

active_onlyboolean

Whether to only return active workflows versions

include_sharedboolean

Whether to include shared workflow versions

workflow_namestring nullable

Exact workflow name to filter by

workflow_searchstring nullable

The workflow name to filter by

archivedboolean nullable

Filter by archived state. False=exclude archived, True=only archived, None=include all

with_workflowboolean

Whether to include the workflow definition

available_in_chat_assistantboolean nullable

Whether to only return workflows available in chat assistant

limitinteger

The maximum number of workflows versions to return

cursorstring nullable

The cursor for pagination

Response

Successful Response

next_cursorstring nullable required

Changes

  • 6c349f3bdef6Revision changes
    • info

      added the new optional query request parameter workflow_name

  • 5a5c361558bbRevision changes
    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      response property workflow_registrations/items/task_queue list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property workflow_versions/items/task_queue list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the / response's property format changed from uuid to no format for status

    • warning

      for the query request parameter limit, the max was set to 1000.00

    • warning

      for the query request parameter limit, the min was set to 1.00

    • info

      api tag workflows added

    • info

      api tag beta.workflows removed

    • info

      for the query request parameter cursor, the format of property anyOf[subschema #1]/ was generalized from uuid to no format

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      response property workflow_registrations/items/task_queue deprecated

    • info

      response property workflow_versions/items/task_queue deprecated