Export flow for runtime | Runtype Documentation

curl https://api.runtype.com/v1/flows/id/export-runtime \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "name": "User Onboarding Flow",
  "steps": [
    {
      "stepId": "verify-email",
      "type": "emailVerification",
      "config": {
        "emailTemplateId": "welcome_01",
        "timeoutMinutes": 15
      }
    },
    {
      "stepId": "profile-setup",
      "type": "form",
      "config": {
        "fields": [
          {
            "name": "firstName",
            "type": "text",
            "required": true
          },
          {
            "name": "lastName",
            "type": "text",
            "required": true
          },
          {
            "name": "birthdate",
            "type": "date",
            "required": false
          }
        ]
      }
    },
    {
      "stepId": "welcome-message",
      "type": "notification",
      "config": {
        "message": "Welcome to Runtype! Your account has been successfully created."
      }
    }
  ],
  "description": "This flow handles the user onboarding process including email verification and profile setup."
}

Export a fully-resolved, self-contained flow definition that the @runtypelabs/runtime package can consume directly at boot. All step configs are inlined; no live DB queries are needed at execution time.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Response

Exported flow definition

idstring

namestring

stepslist of maps from strings to any

descriptionstring or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl https://api.runtype.com/v1/flows/id/export-runtime \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

1	{
2	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3	"name": "User Onboarding Flow",
4	"steps": [
5	{
6	"stepId": "verify-email",
7	"type": "emailVerification",
8	"config": {
9	"emailTemplateId": "welcome_01",
10	"timeoutMinutes": 15
11	}
12	},
13	{
14	"stepId": "profile-setup",
15	"type": "form",
16	"config": {
17	"fields": [
18	{
19	"name": "firstName",
20	"type": "text",
21	"required": true
22	},
23	{
24	"name": "lastName",
25	"type": "text",
26	"required": true
27	},
28	{
29	"name": "birthdate",
30	"type": "date",
31	"required": false
32	}
33	]
34	}
35	},
36	{
37	"stepId": "welcome-message",
38	"type": "notification",
39	"config": {
40	"message": "Welcome to Runtype! Your account has been successfully created."
41	}
42	}
43	],
44	"description": "This flow handles the user onboarding process including email verification and profile setup."
45	}