Workflows

Query workflows

Changed on
get/v2/consumer/workflows

Request

  • The document declares no server URL.
  • Auth: none required

Query parameters

cursorstring

An optional cursor to continue querying workflows from a previous query.

takeinteger
tagsstring[]
excludeTagsstring[]

An optional list of tags; workflows with any of these tags are excluded

querystring

An optional additional query that is used to match workflows through metadata

ascendingboolean

Whether to return data from oldest to newest

hideMatureContentboolean

When set to true, any blob that has mature won't be available and won't have a URL

fromDatestring date-time

An optional start date to filter workflows created on or after this date

toDatestring date-time

An optional end date to filter workflows created on or before this date

excludeFailedboolean

When set to true, excludes workflows with Failed, Expired, or Canceled status

Headers

Acceptstring

Specify 'application/zip' to get the response as a zip file

Response

OK

nextstring required

Example response

{
  "items": [
    {
      "callbacks": [
        {
          "type": [
            "workflow:succeeded"
          ]
        }
      ]
    }
  ]
}

Changes

  • 48103e81ab94Revision changes
    • info

      added liveTextToSpeech promptModeration discriminator mapping keys to the /// response property for the response status

  • e3d4f2c08853Revision changes
    • warning

      added the new idle enum value to the // response property for the response status

    • warning

      added the new idle enum value to the ////// response property for the response status

    • warning

      added the new idle enum value to the //// response property for the response status

    • info

      added the new optional query request parameter excludeTags

    • info

      added liveTranscription merge discriminator mapping keys to the /// response property for the response status

    • info

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