SteveSteve

Get immutable workflow version contract

GET/api/v1/workflows/{slug}/versions/{version}

Authorization

AuthorizationRequiredBearer <token>

Company-scoped Steve API key. Format: Authorization: Bearer aok_...

In: header

Path Parameters

slugRequiredstring

Workflow slug.

versionRequiredinteger

Immutable workflow version number.

Minimum: 1

Header Parameters

X-Request-Idstring

Optional caller-supplied request identifier. Maximum length is 128 characters.

Maximum length: 128
curl -X GET "https://your-deployment.convex.site/api/v1/workflows/<string>/versions/1" \
  -H "X-Request-Id: <string>" \
  -H "Authorization: Bearer <token>"

Immutable upload and output contract for the requested workflow version

{
  "workflow": {
    "id": "string",
    "slug": "string",
    "name": "string",
    "description": "string",
    "icon": "string",
    "color": "string"
  },
  "version": 0,
  "upload": {
    "minFiles": 0,
    "maxFiles": 0,
    "acceptedFormats": [
      "string"
    ],
    "fileLabels": [
      "string"
    ],
    "maxFileSizeMb": 0
  },
  "outputSchema": [
    {
      "name": "string",
      "label": "string",
      "required": true,
      "description": "string",
      "type": "string",
      "validation": {
        "pattern": "string",
        "minLength": 0,
        "maxLength": 0
      }
    }
  ],
  "outputJsonSchema": {}
}