Create a Lead Finder search and start its first run

curl --request POST \
  --url https://app.puffle.ai/api/lead-finder \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "intent": "<string>",
  "origin": "prompt",
  "sourcePlan": {
    "query": [
      "<string>"
    ],
    "reason": "<string>",
    "resultTarget": {
      "mode": "count",
      "count": 4503599627370495
    },
    "companySize": {
      "min": 4503599627370495,
      "max": 4503599627370495
    },
    "personCriteria": [
      {
        "id": "<string>",
        "kind": "current_title",
        "values": [
          "<string>"
        ]
      }
    ],
    "unresolvedPreferences": [
      "<string>"
    ],
    "companyCriteria": [
      {
        "id": "<string>",
        "value": "<string>"
      }
    ],
    "rankedCompanyCohort": {
      "kind": "default",
      "limit": 4503599627370495
    }
  },
  "description": "<string>",
  "creationPrompt": "<string>",
  "details": {
    "channel": "<string>",
    "signal": "<string>",
    "expectedLead": "<string>",
    "whyThisShouldWork": "<string>",
    "plannerAssumedPreferences": [
      "<string>"
    ]
  }
}
'

import requests

url = "https://app.puffle.ai/api/lead-finder"

payload = {
    "title": "<string>",
    "intent": "<string>",
    "origin": "prompt",
    "sourcePlan": {
        "query": ["<string>"],
        "reason": "<string>",
        "resultTarget": {
            "mode": "count",
            "count": 4503599627370495
        },
        "companySize": {
            "min": 4503599627370495,
            "max": 4503599627370495
        },
        "personCriteria": [
            {
                "id": "<string>",
                "kind": "current_title",
                "values": ["<string>"]
            }
        ],
        "unresolvedPreferences": ["<string>"],
        "companyCriteria": [
            {
                "id": "<string>",
                "value": "<string>"
            }
        ],
        "rankedCompanyCohort": {
            "kind": "default",
            "limit": 4503599627370495
        }
    },
    "description": "<string>",
    "creationPrompt": "<string>",
    "details": {
        "channel": "<string>",
        "signal": "<string>",
        "expectedLead": "<string>",
        "whyThisShouldWork": "<string>",
        "plannerAssumedPreferences": ["<string>"]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    intent: '<string>',
    origin: 'prompt',
    sourcePlan: {
      query: ['<string>'],
      reason: '<string>',
      resultTarget: {mode: 'count', count: 4503599627370495},
      companySize: {min: 4503599627370495, max: 4503599627370495},
      personCriteria: [{id: '<string>', kind: 'current_title', values: ['<string>']}],
      unresolvedPreferences: ['<string>'],
      companyCriteria: [{id: '<string>', value: '<string>'}],
      rankedCompanyCohort: {kind: 'default', limit: 4503599627370495}
    },
    description: '<string>',
    creationPrompt: '<string>',
    details: {
      channel: '<string>',
      signal: '<string>',
      expectedLead: '<string>',
      whyThisShouldWork: '<string>',
      plannerAssumedPreferences: ['<string>']
    }
  })
};

fetch('https://app.puffle.ai/api/lead-finder', 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://app.puffle.ai/api/lead-finder",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'intent' => '<string>',
    'origin' => 'prompt',
    'sourcePlan' => [
        'query' => [
                '<string>'
        ],
        'reason' => '<string>',
        'resultTarget' => [
                'mode' => 'count',
                'count' => 4503599627370495
        ],
        'companySize' => [
                'min' => 4503599627370495,
                'max' => 4503599627370495
        ],
        'personCriteria' => [
                [
                                'id' => '<string>',
                                'kind' => 'current_title',
                                'values' => [
                                                                '<string>'
                                ]
                ]
        ],
        'unresolvedPreferences' => [
                '<string>'
        ],
        'companyCriteria' => [
                [
                                'id' => '<string>',
                                'value' => '<string>'
                ]
        ],
        'rankedCompanyCohort' => [
                'kind' => 'default',
                'limit' => 4503599627370495
        ]
    ],
    'description' => '<string>',
    'creationPrompt' => '<string>',
    'details' => [
        'channel' => '<string>',
        'signal' => '<string>',
        'expectedLead' => '<string>',
        'whyThisShouldWork' => '<string>',
        'plannerAssumedPreferences' => [
                '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.puffle.ai/api/lead-finder"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"intent\": \"<string>\",\n  \"origin\": \"prompt\",\n  \"sourcePlan\": {\n    \"query\": [\n      \"<string>\"\n    ],\n    \"reason\": \"<string>\",\n    \"resultTarget\": {\n      \"mode\": \"count\",\n      \"count\": 4503599627370495\n    },\n    \"companySize\": {\n      \"min\": 4503599627370495,\n      \"max\": 4503599627370495\n    },\n    \"personCriteria\": [\n      {\n        \"id\": \"<string>\",\n        \"kind\": \"current_title\",\n        \"values\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"unresolvedPreferences\": [\n      \"<string>\"\n    ],\n    \"companyCriteria\": [\n      {\n        \"id\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"rankedCompanyCohort\": {\n      \"kind\": \"default\",\n      \"limit\": 4503599627370495\n    }\n  },\n  \"description\": \"<string>\",\n  \"creationPrompt\": \"<string>\",\n  \"details\": {\n    \"channel\": \"<string>\",\n    \"signal\": \"<string>\",\n    \"expectedLead\": \"<string>\",\n    \"whyThisShouldWork\": \"<string>\",\n    \"plannerAssumedPreferences\": [\n      \"<string>\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.puffle.ai/api/lead-finder")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"intent\": \"<string>\",\n  \"origin\": \"prompt\",\n  \"sourcePlan\": {\n    \"query\": [\n      \"<string>\"\n    ],\n    \"reason\": \"<string>\",\n    \"resultTarget\": {\n      \"mode\": \"count\",\n      \"count\": 4503599627370495\n    },\n    \"companySize\": {\n      \"min\": 4503599627370495,\n      \"max\": 4503599627370495\n    },\n    \"personCriteria\": [\n      {\n        \"id\": \"<string>\",\n        \"kind\": \"current_title\",\n        \"values\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"unresolvedPreferences\": [\n      \"<string>\"\n    ],\n    \"companyCriteria\": [\n      {\n        \"id\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"rankedCompanyCohort\": {\n      \"kind\": \"default\",\n      \"limit\": 4503599627370495\n    }\n  },\n  \"description\": \"<string>\",\n  \"creationPrompt\": \"<string>\",\n  \"details\": {\n    \"channel\": \"<string>\",\n    \"signal\": \"<string>\",\n    \"expectedLead\": \"<string>\",\n    \"whyThisShouldWork\": \"<string>\",\n    \"plannerAssumedPreferences\": [\n      \"<string>\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.puffle.ai/api/lead-finder")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"intent\": \"<string>\",\n  \"origin\": \"prompt\",\n  \"sourcePlan\": {\n    \"query\": [\n      \"<string>\"\n    ],\n    \"reason\": \"<string>\",\n    \"resultTarget\": {\n      \"mode\": \"count\",\n      \"count\": 4503599627370495\n    },\n    \"companySize\": {\n      \"min\": 4503599627370495,\n      \"max\": 4503599627370495\n    },\n    \"personCriteria\": [\n      {\n        \"id\": \"<string>\",\n        \"kind\": \"current_title\",\n        \"values\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"unresolvedPreferences\": [\n      \"<string>\"\n    ],\n    \"companyCriteria\": [\n      {\n        \"id\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"rankedCompanyCohort\": {\n      \"kind\": \"default\",\n      \"limit\": 4503599627370495\n    }\n  },\n  \"description\": \"<string>\",\n  \"creationPrompt\": \"<string>\",\n  \"details\": {\n    \"channel\": \"<string>\",\n    \"signal\": \"<string>\",\n    \"expectedLead\": \"<string>\",\n    \"whyThisShouldWork\": \"<string>\",\n    \"plannerAssumedPreferences\": [\n      \"<string>\"\n    ]\n  }\n}"

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

{
  "search": {
    "searchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "description": "<string>",
    "scheduleEnabled": true,
    "definitionHash": "<string>",
    "intent": "<string>",
    "sellerContext": "<string>",
    "sourcePlans": [
      {
        "query": [
          "<string>"
        ],
        "reason": "<string>",
        "resultTarget": {
          "mode": "count",
          "count": 4503599627370495
        },
        "geography": {
          "mode": "explicit",
          "countryCodes": [
            "<string>"
          ],
          "cityNames": [
            "<string>"
          ]
        },
        "companySize": {
          "min": 4503599627370495,
          "max": 4503599627370495
        },
        "personCriteria": [
          {
            "id": "<string>",
            "kind": "current_title",
            "values": [
              "<string>"
            ]
          }
        ],
        "unresolvedPreferences": [
          "<string>"
        ],
        "companyCriteria": [
          {
            "id": "<string>",
            "value": "<string>"
          }
        ],
        "rankedCompanyCohort": {
          "kind": "default",
          "limit": 4503599627370495
        }
      }
    ],
    "details": {
      "channel": "<string>",
      "signal": "<string>",
      "expectedLead": "<string>",
      "whyThisShouldWork": "<string>",
      "plannerAssumedPreferences": [
        "<string>"
      ]
    },
    "lastRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outboundCampaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "leadCount": 4503599627370495,
    "resultCount": 4503599627370495,
    "contactedCount": 4503599627370495,
    "nextRunAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  },
  "run": {
    "runId": "<string>",
    "triggerRunId": "<string>",
    "continuationRetryAfter": "2023-11-07T05:31:56Z",
    "counts": {}
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "sourceId": "<string>",
  "code": "<string>",
  "alternatives": [
    "<string>"
  ],
  "retryable": true,
  "alert": true,
  "action": {
    "type": "navigate",
    "label": "<string>",
    "href": "<string>"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "sourceId": "<string>",
  "code": "<string>",
  "alternatives": [
    "<string>"
  ],
  "retryable": true,
  "alert": true,
  "action": {
    "type": "navigate",
    "label": "<string>",
    "href": "<string>"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "sourceId": "<string>",
  "code": "<string>",
  "alternatives": [
    "<string>"
  ],
  "retryable": true,
  "alert": true,
  "action": {
    "type": "navigate",
    "label": "<string>",
    "href": "<string>"
  }
}

POST

api

lead-finder

Create a Lead Finder search and start its first run

curl --request POST \
  --url https://app.puffle.ai/api/lead-finder \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "intent": "<string>",
  "origin": "prompt",
  "sourcePlan": {
    "query": [
      "<string>"
    ],
    "reason": "<string>",
    "resultTarget": {
      "mode": "count",
      "count": 4503599627370495
    },
    "companySize": {
      "min": 4503599627370495,
      "max": 4503599627370495
    },
    "personCriteria": [
      {
        "id": "<string>",
        "kind": "current_title",
        "values": [
          "<string>"
        ]
      }
    ],
    "unresolvedPreferences": [
      "<string>"
    ],
    "companyCriteria": [
      {
        "id": "<string>",
        "value": "<string>"
      }
    ],
    "rankedCompanyCohort": {
      "kind": "default",
      "limit": 4503599627370495
    }
  },
  "description": "<string>",
  "creationPrompt": "<string>",
  "details": {
    "channel": "<string>",
    "signal": "<string>",
    "expectedLead": "<string>",
    "whyThisShouldWork": "<string>",
    "plannerAssumedPreferences": [
      "<string>"
    ]
  }
}
'

import requests

url = "https://app.puffle.ai/api/lead-finder"

payload = {
    "title": "<string>",
    "intent": "<string>",
    "origin": "prompt",
    "sourcePlan": {
        "query": ["<string>"],
        "reason": "<string>",
        "resultTarget": {
            "mode": "count",
            "count": 4503599627370495
        },
        "companySize": {
            "min": 4503599627370495,
            "max": 4503599627370495
        },
        "personCriteria": [
            {
                "id": "<string>",
                "kind": "current_title",
                "values": ["<string>"]
            }
        ],
        "unresolvedPreferences": ["<string>"],
        "companyCriteria": [
            {
                "id": "<string>",
                "value": "<string>"
            }
        ],
        "rankedCompanyCohort": {
            "kind": "default",
            "limit": 4503599627370495
        }
    },
    "description": "<string>",
    "creationPrompt": "<string>",
    "details": {
        "channel": "<string>",
        "signal": "<string>",
        "expectedLead": "<string>",
        "whyThisShouldWork": "<string>",
        "plannerAssumedPreferences": ["<string>"]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    intent: '<string>',
    origin: 'prompt',
    sourcePlan: {
      query: ['<string>'],
      reason: '<string>',
      resultTarget: {mode: 'count', count: 4503599627370495},
      companySize: {min: 4503599627370495, max: 4503599627370495},
      personCriteria: [{id: '<string>', kind: 'current_title', values: ['<string>']}],
      unresolvedPreferences: ['<string>'],
      companyCriteria: [{id: '<string>', value: '<string>'}],
      rankedCompanyCohort: {kind: 'default', limit: 4503599627370495}
    },
    description: '<string>',
    creationPrompt: '<string>',
    details: {
      channel: '<string>',
      signal: '<string>',
      expectedLead: '<string>',
      whyThisShouldWork: '<string>',
      plannerAssumedPreferences: ['<string>']
    }
  })
};

fetch('https://app.puffle.ai/api/lead-finder', 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://app.puffle.ai/api/lead-finder",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'intent' => '<string>',
    'origin' => 'prompt',
    'sourcePlan' => [
        'query' => [
                '<string>'
        ],
        'reason' => '<string>',
        'resultTarget' => [
                'mode' => 'count',
                'count' => 4503599627370495
        ],
        'companySize' => [
                'min' => 4503599627370495,
                'max' => 4503599627370495
        ],
        'personCriteria' => [
                [
                                'id' => '<string>',
                                'kind' => 'current_title',
                                'values' => [
                                                                '<string>'
                                ]
                ]
        ],
        'unresolvedPreferences' => [
                '<string>'
        ],
        'companyCriteria' => [
                [
                                'id' => '<string>',
                                'value' => '<string>'
                ]
        ],
        'rankedCompanyCohort' => [
                'kind' => 'default',
                'limit' => 4503599627370495
        ]
    ],
    'description' => '<string>',
    'creationPrompt' => '<string>',
    'details' => [
        'channel' => '<string>',
        'signal' => '<string>',
        'expectedLead' => '<string>',
        'whyThisShouldWork' => '<string>',
        'plannerAssumedPreferences' => [
                '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.puffle.ai/api/lead-finder"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"intent\": \"<string>\",\n  \"origin\": \"prompt\",\n  \"sourcePlan\": {\n    \"query\": [\n      \"<string>\"\n    ],\n    \"reason\": \"<string>\",\n    \"resultTarget\": {\n      \"mode\": \"count\",\n      \"count\": 4503599627370495\n    },\n    \"companySize\": {\n      \"min\": 4503599627370495,\n      \"max\": 4503599627370495\n    },\n    \"personCriteria\": [\n      {\n        \"id\": \"<string>\",\n        \"kind\": \"current_title\",\n        \"values\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"unresolvedPreferences\": [\n      \"<string>\"\n    ],\n    \"companyCriteria\": [\n      {\n        \"id\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"rankedCompanyCohort\": {\n      \"kind\": \"default\",\n      \"limit\": 4503599627370495\n    }\n  },\n  \"description\": \"<string>\",\n  \"creationPrompt\": \"<string>\",\n  \"details\": {\n    \"channel\": \"<string>\",\n    \"signal\": \"<string>\",\n    \"expectedLead\": \"<string>\",\n    \"whyThisShouldWork\": \"<string>\",\n    \"plannerAssumedPreferences\": [\n      \"<string>\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.puffle.ai/api/lead-finder")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"intent\": \"<string>\",\n  \"origin\": \"prompt\",\n  \"sourcePlan\": {\n    \"query\": [\n      \"<string>\"\n    ],\n    \"reason\": \"<string>\",\n    \"resultTarget\": {\n      \"mode\": \"count\",\n      \"count\": 4503599627370495\n    },\n    \"companySize\": {\n      \"min\": 4503599627370495,\n      \"max\": 4503599627370495\n    },\n    \"personCriteria\": [\n      {\n        \"id\": \"<string>\",\n        \"kind\": \"current_title\",\n        \"values\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"unresolvedPreferences\": [\n      \"<string>\"\n    ],\n    \"companyCriteria\": [\n      {\n        \"id\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"rankedCompanyCohort\": {\n      \"kind\": \"default\",\n      \"limit\": 4503599627370495\n    }\n  },\n  \"description\": \"<string>\",\n  \"creationPrompt\": \"<string>\",\n  \"details\": {\n    \"channel\": \"<string>\",\n    \"signal\": \"<string>\",\n    \"expectedLead\": \"<string>\",\n    \"whyThisShouldWork\": \"<string>\",\n    \"plannerAssumedPreferences\": [\n      \"<string>\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.puffle.ai/api/lead-finder")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"intent\": \"<string>\",\n  \"origin\": \"prompt\",\n  \"sourcePlan\": {\n    \"query\": [\n      \"<string>\"\n    ],\n    \"reason\": \"<string>\",\n    \"resultTarget\": {\n      \"mode\": \"count\",\n      \"count\": 4503599627370495\n    },\n    \"companySize\": {\n      \"min\": 4503599627370495,\n      \"max\": 4503599627370495\n    },\n    \"personCriteria\": [\n      {\n        \"id\": \"<string>\",\n        \"kind\": \"current_title\",\n        \"values\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"unresolvedPreferences\": [\n      \"<string>\"\n    ],\n    \"companyCriteria\": [\n      {\n        \"id\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"rankedCompanyCohort\": {\n      \"kind\": \"default\",\n      \"limit\": 4503599627370495\n    }\n  },\n  \"description\": \"<string>\",\n  \"creationPrompt\": \"<string>\",\n  \"details\": {\n    \"channel\": \"<string>\",\n    \"signal\": \"<string>\",\n    \"expectedLead\": \"<string>\",\n    \"whyThisShouldWork\": \"<string>\",\n    \"plannerAssumedPreferences\": [\n      \"<string>\"\n    ]\n  }\n}"

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

{
  "search": {
    "searchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "description": "<string>",
    "scheduleEnabled": true,
    "definitionHash": "<string>",
    "intent": "<string>",
    "sellerContext": "<string>",
    "sourcePlans": [
      {
        "query": [
          "<string>"
        ],
        "reason": "<string>",
        "resultTarget": {
          "mode": "count",
          "count": 4503599627370495
        },
        "geography": {
          "mode": "explicit",
          "countryCodes": [
            "<string>"
          ],
          "cityNames": [
            "<string>"
          ]
        },
        "companySize": {
          "min": 4503599627370495,
          "max": 4503599627370495
        },
        "personCriteria": [
          {
            "id": "<string>",
            "kind": "current_title",
            "values": [
              "<string>"
            ]
          }
        ],
        "unresolvedPreferences": [
          "<string>"
        ],
        "companyCriteria": [
          {
            "id": "<string>",
            "value": "<string>"
          }
        ],
        "rankedCompanyCohort": {
          "kind": "default",
          "limit": 4503599627370495
        }
      }
    ],
    "details": {
      "channel": "<string>",
      "signal": "<string>",
      "expectedLead": "<string>",
      "whyThisShouldWork": "<string>",
      "plannerAssumedPreferences": [
        "<string>"
      ]
    },
    "lastRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outboundCampaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "leadCount": 4503599627370495,
    "resultCount": 4503599627370495,
    "contactedCount": 4503599627370495,
    "nextRunAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  },
  "run": {
    "runId": "<string>",
    "triggerRunId": "<string>",
    "continuationRetryAfter": "2023-11-07T05:31:56Z",
    "counts": {}
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "sourceId": "<string>",
  "code": "<string>",
  "alternatives": [
    "<string>"
  ],
  "retryable": true,
  "alert": true,
  "action": {
    "type": "navigate",
    "label": "<string>",
    "href": "<string>"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "sourceId": "<string>",
  "code": "<string>",
  "alternatives": [
    "<string>"
  ],
  "retryable": true,
  "alert": true,
  "action": {
    "type": "navigate",
    "label": "<string>",
    "href": "<string>"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "sourceId": "<string>",
  "code": "<string>",
  "alternatives": [
    "<string>"
  ],
  "retryable": true,
  "alert": true,
  "action": {
    "type": "navigate",
    "label": "<string>",
    "href": "<string>"
  }
}

CLI:

puffle lead-finder create --title <title> --intent <intent> --source-plan <source-plan>
puffle lead-finder create --title <title> --intent <intent> --source-plan <source-plan> --description <description> --origin <origin> --creation-prompt <creation-prompt> --details <details>

Overview

Create a Lead Finder search and start its first run This page documents post /api/lead-finder. Use the request and response sections on this page for accepted parameters, payload fields, response fields, and authentication behavior.

AI agent notes

Confirm the operation matches the user’s intent before calling it.
For write operations, confirm the user intends to change state.
Surface validation, permission, and not-found errors instead of retrying unchanged.

Authorizations

Authorization

string

header

required

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

Body

application/json

title

string

required

Required string length: 1 - 180

intent

string

required

Minimum string length: 1

origin

enum<string>

default:prompt

required

Available options:

prompt,

planner

sourcePlan

object

required

Show child attributes

description

string

Maximum string length: 500

creationPrompt

string

Minimum string length: 1

details

object

Show child attributes

Response

Search created.

Option 1
Option 2

object

required

Show child attributes

run

object

required

Show child attributes

dispatch

enum<string>

required

Available options:

recorded,

accepted_unrecorded,

existing

searchDisposition

enum<string>

required

Available options:

created,

reused

runDisposition

enum<string>

required

Available options:

queued,

existing

​Overview

​AI agent notes

Authorizations

Body

Response

Overview

AI agent notes