Pull flow definition (config-as-code)

{
  "contentHash": "a3f5c9d8e7b2f1a4c6d8e9f0b1a2c3d4e5f67890",
  "definition": {
    "name": "User Signup Flow",
    "steps": [
      {
        "name": "Verify Email",
        "type": "email_verification",
        "config": {
          "emailVerificationRequired": true,
          "welcomeEmailTemplate": "welcome_v1"
        },
        "enabled": true,
        "order": 1,
        "when": "user.signup"
      }
    ]
  },
  "flowId": "flow_9b8f7e6d5c4a3b2f1e0d9c8b7a6f5e4d",
  "lastModifiedSource": "dashboard",
  "updatedAt": "2024-06-10T15:22:30Z",
  "versionId": "v1.3.7",
  "warnings": [
    "Tool reference 'tool_12345' could not be resolved; please update to a portable tool name."
  ]
}

Return the canonical config-as-code definition and provenance for a flow by name — the absorb-drift direction of the ensure protocol. The contentHash is recomputed from the live flow state, so it is accurate even immediately after a dashboard edit.

Authentication

AuthorizationBearer

API key or Clerk session token

Query parameters

namestringRequired>=1 character

Response

Canonical definition + provenance

contentHashstring

definitionobject

flowIdstring

lastModifiedSourcestring or null

updatedAtstring or null

versionIdstring or null

warningslist of strings

Present only when a raw tool_… reference could not be emitted as a portable tool:<name> (the tool was deleted, or its name is shadowed by an older same-named tool). Those references are left as raw ids, which the ensure surface rejects; each warning explains how to fix it.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -G https://api.runtype.com/v1/flows/pull \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d name=name