SteveSteve

Get current workflow contract summary

GET/api/v1/workflows/{slug}

Authorization

AuthorizationRequiredBearer <token>

Steve API key, usually scoped to a company. Legacy keys and keys created by platform administrators may be unscoped; company-scoped endpoints reject unscoped keys with 403 Forbidden. Format: Authorization: Bearer aok_...

In: header

Path Parameters

slugRequiredstring

Workflow slug.

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>" \
  -H "X-Request-Id: <string>" \
  -H "Authorization: Bearer <token>"

Current published workflow contract summary

{
  "id": "string",
  "slug": "string",
  "name": "string",
  "description": "string",
  "icon": "string",
  "color": "string",
  "publishedVersion": 0,
  "contractUrl": "string",
  "upload": {
    "minFiles": 0,
    "maxFiles": 0,
    "acceptedFormats": [
      "string"
    ],
    "fileLabels": [
      "string"
    ],
    "maxFileSizeMb": 0
  }
}

Previous

List accessible workflows

Next

Create a workflow upload session