POST /v1/projects/{projectId}/routes/generate
Generate a routing rule configuration from a natural language description. Returns a suggested route configuration that can be reviewed and saved.
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectId |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
teamId |
String | No |
The Team identifier to perform the request on behalf of. |
slug |
String | No |
The Team slug to perform the request on behalf of. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
prompt |
String | Yes | |
currentRoute |
Object | No | |
currentRoute.actions[] |
Array | Yes | |
currentRoute.actions[].dest |
String | No | |
currentRoute.actions[].type |
String | No | |
currentRoute.actions[].status |
Integer | No | |
currentRoute.actions[].headers[] |
Array | No | |
currentRoute.actions[].headers[].key |
String | No | |
currentRoute.actions[].headers[].op |
String | No | |
currentRoute.actions[].headers[].value |
String | No | |
currentRoute.actions[].subType |
String | No | |
currentRoute.name |
String | No | |
currentRoute.description |
String | No | |
currentRoute.conditions[] |
Array | No | |
currentRoute.conditions[].field |
String | No | |
currentRoute.conditions[].operator |
String | No | |
currentRoute.conditions[].key |
String | No | |
currentRoute.conditions[].missing |
Boolean | No | |
currentRoute.conditions[].value |
String | No | |
currentRoute.pathCondition |
Object | Yes | |
currentRoute.pathCondition.syntax |
String | No | |
currentRoute.pathCondition.value |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.