Workflows

Create a new workflow

Changed on
post/api/workflows

Request

  • Base URL
    http://localhost:3013
  • URL
    http://localhost:3013/api/workflows
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

Optional client-generated key, 1-255 visible ASCII characters (a UUID works). The first request the server accepts under a key creates one workflow; a retry with the same key and an equivalent body gets that request's status and body back (with Idempotent-Replayed: true) and changes nothing. The key is scoped to the caller's identity and this operation; it is not a credential. The same key with a different body is a 409. A request rejected before it is accepted (validation, auth, not found, disabled) does not use up the key. Accepted keys do not expire.

Request body

namestring required
keystring

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

descriptionstring
inputobject
triggerSchemaobject
paramsobject
requiredParamsstring[]
requiresstring[]
dirstring
vcsRepostring

Response

Workflow created

idstring uuid required
keystring required

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

namestring required
descriptionstring
enabledboolean required
inputobject
triggerSchemaobject
paramsobject
requiredParamsstring[]
requiresstring[]
dirstring
vcsRepostring
createdByAgentIdstring
createdAtstring required
lastUpdatedAtstring required
createdBystring
updatedBystring
favoriteboolean
warningsstring[]

Changes

    • info

      added the new optional request property /

    • info

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

    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status