Convert flow to tool | Runtype Documentation

curl -X POST https://api.runtype.com/v1/tools/flows/flowId/convert-to-tool \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "description": "Analyze customer data using the Customer Analysis flow",
  "name": "Customer Analysis Tool",
  "outputMapping": "steps.final_analysis.result",
  "parameterMapping": {
    "customerEmail": "record.metadata.email",
    "customerName": "record.metadata.name"
  }
}'

{
  "config": {},
  "createdAt": "string",
  "description": "string",
  "id": "string",
  "isActive": true,
  "name": "string",
  "organizationId": "string",
  "toolType": "string",
  "updatedAt": "string",
  "userId": "string",
  "lastModifiedSource": "string",
  "parametersSchema": {},
  "validation": {
    "warnings": [
      {
        "code": "string",
        "message": "string",
        "severity": "error",
        "column": 1.1,
        "line": 1.1,
        "suggestion": "string"
      }
    ],
    "recommendations": [
      {
        "code": "string",
        "message": "string",
        "path": "string",
        "step": {
          "index": 1,
          "name": "string",
          "type": "string"
        }
      }
    ]
  }
}

Create a flow-type tool from an existing flow, generating its parameters schema from the flow steps.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

flowIdstringRequired

Request

This endpoint expects a map from strings to any.

Response

Created tool

configmap from strings to any or null

createdAtstring

descriptionstring or null

idstring

isActiveboolean

namestring

organizationIdstring or null

toolTypestring

updatedAtstring

userIdstring or null

lastModifiedSourcestring or nullOptional

parametersSchemamap from strings to anyOptional

validationobjectOptional

Non-blocking findings from a successful write. warnings also carries SESSION_PREVIEW_URL when config.url or config.serverUrl is a session sandbox preview URL, which stops working when that sandbox container stops.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error