Recipes

List the recipes Prelude maintains

Beta. The request and response shapes may still change.

List the Prelude-authored recipes you can extend. To use one, create a recipe of your own with base_recipe_id set to its identifier: your recipe scores the managed recipe’s rules, which you cannot change, plus any rules you add, and sets the parameters the managed recipe exposes within their bounds.

A managed recipe is opaque: it is returned with a description, its threshold and the parameters you may set. Its rules are not returned.

GET

watch

management

recipes

managed

List managed recipes

curl --request GET \
  --url https://api.prelude.dev/v2/watch/management/recipes/managed \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.prelude.dev/v2/watch/management/recipes/managed"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prelude.dev/v2/watch/management/recipes/managed', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prelude.dev/v2/watch/management/recipes/managed",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prelude.dev/v2/watch/management/recipes/managed"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/watch/management/recipes/managed")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "recipes": [
    {
      "id": "rcp_01jc0t6fwwfgfsq1md24mhyztj",
      "description": "Flags SMS pumping: bursts of verifications to premium-rate numbers.",
      "threshold": 50,
      "parameters": {},
      "threshold_bounds": {
        "min": 30,
        "max": 80
      }
    }
  ],
  "next_cursor": "rcp_01jc0t6fwwfgfsq1md24mhyztj"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

Managed recipes are Prelude’s own: ready-made protections every customer can extend and none can edit. To use one, create a recipe with base_recipe_id set to its identifier, and add the recipe to a flow.

What you can change

A recipe extending a managed recipe:

Scores the managed recipe’s rules, which Prelude maintains. They are not listed, and you cannot change or remove them.
Can add rules of its own - yours or managed rules - with weights you choose.
Sets the parameters the managed recipe exposes, by the keys of its parameters, within their bounds: a BOOL, an INT or DOUBLE between value_min and value_max, a STRING, or an ENUM from its values. A parameter you leave unset uses its default_value.
Moves the threshold within threshold_bounds. Without bounds, the threshold is the managed recipe’s.

{
  "name": "sms_pumping",
  "status": "SHADOW",
  "threshold": 60,
  "rules": [],
  "base_recipe_id": "rcp_01jc0t6fwwfgfsq1md24mhyztj",
  "parameters": { "max_attempts": "8", "level": "high" }
}

What you get, and what you don’t

A managed recipe is returned with an identifier, a description, its threshold and the parameters you may set. Its name and its rules are not returned: a managed recipe is opaque. A recipe extending it lists only the rules you add.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit

integer

default:50

Maximum number of recipes to return per page. A larger value is clamped to 200 rather than refused.

Required range: 1 <= x <= 200

cursor

string

Pagination cursor from the previous response.

Response

recipes

object[]

required

Show child attributes

next_cursor

string

Pass this back as cursor for the next page. Absent on the last page.

Example:

"rcp_01jc0t6fwwfgfsq1md24mhyztj"

List managed recipes

curl --request GET \
  --url https://api.prelude.dev/v2/watch/management/recipes/managed \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.prelude.dev/v2/watch/management/recipes/managed"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prelude.dev/v2/watch/management/recipes/managed', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prelude.dev/v2/watch/management/recipes/managed",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prelude.dev/v2/watch/management/recipes/managed"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/watch/management/recipes/managed")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "recipes": [
    {
      "id": "rcp_01jc0t6fwwfgfsq1md24mhyztj",
      "description": "Flags SMS pumping: bursts of verifications to premium-rate numbers.",
      "threshold": 50,
      "parameters": {},
      "threshold_bounds": {
        "min": 30,
        "max": 80
      }
    }
  ],
  "next_cursor": "rcp_01jc0t6fwwfgfsq1md24mhyztj"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

Documentation

API Reference

Management API

List the recipes Prelude maintains

What you can change

What you get, and what you don’t

Authorizations

Query Parameters

Response

​What you can change

​What you get, and what you don’t

Authorizations

Query Parameters

Response

What you can change

What you get, and what you don’t