Preview a provider order
curl --request POST \
--url https://api.getoneprofile.ai/provider-keys/enrichments/{action_key}/providers/preview/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"providers": {
"preset": "recommended",
"steps": [
{
"integration_type": "<string>",
"operation_key": "<string>",
"enabled": true,
"fields": [
"<string>"
],
"pay_with": "credits"
}
]
},
"second_check": false
}
'import requests
url = "https://api.getoneprofile.ai/provider-keys/enrichments/{action_key}/providers/preview/"
payload = {
"providers": {
"preset": "recommended",
"steps": [
{
"integration_type": "<string>",
"operation_key": "<string>",
"enabled": True,
"fields": ["<string>"],
"pay_with": "credits"
}
]
},
"second_check": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
providers: {
preset: 'recommended',
steps: [
{
integration_type: '<string>',
operation_key: '<string>',
enabled: true,
fields: ['<string>'],
pay_with: 'credits'
}
]
},
second_check: false
})
};
fetch('https://api.getoneprofile.ai/provider-keys/enrichments/{action_key}/providers/preview/', 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.getoneprofile.ai/provider-keys/enrichments/{action_key}/providers/preview/",
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([
'providers' => [
'preset' => 'recommended',
'steps' => [
[
'integration_type' => '<string>',
'operation_key' => '<string>',
'enabled' => true,
'fields' => [
'<string>'
],
'pay_with' => 'credits'
]
]
],
'second_check' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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://api.getoneprofile.ai/provider-keys/enrichments/{action_key}/providers/preview/"
payload := strings.NewReader("{\n \"providers\": {\n \"preset\": \"recommended\",\n \"steps\": [\n {\n \"integration_type\": \"<string>\",\n \"operation_key\": \"<string>\",\n \"enabled\": true,\n \"fields\": [\n \"<string>\"\n ],\n \"pay_with\": \"credits\"\n }\n ]\n },\n \"second_check\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://api.getoneprofile.ai/provider-keys/enrichments/{action_key}/providers/preview/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"providers\": {\n \"preset\": \"recommended\",\n \"steps\": [\n {\n \"integration_type\": \"<string>\",\n \"operation_key\": \"<string>\",\n \"enabled\": true,\n \"fields\": [\n \"<string>\"\n ],\n \"pay_with\": \"credits\"\n }\n ]\n },\n \"second_check\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/provider-keys/enrichments/{action_key}/providers/preview/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"providers\": {\n \"preset\": \"recommended\",\n \"steps\": [\n {\n \"integration_type\": \"<string>\",\n \"operation_key\": \"<string>\",\n \"enabled\": true,\n \"fields\": [\n \"<string>\"\n ],\n \"pay_with\": \"credits\"\n }\n ]\n },\n \"second_check\": false\n}"
response = http.request(request)
puts response.read_body{
"max_credits_per_row": 123,
"runs_recommended": true,
"steps": [
{
"fields": [
"<string>"
],
"integration_type": "<string>",
"operation_key": "<string>",
"pay_with": "credits",
"price_credits": 123,
"provider_name": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}provider-keys
Preview a provider order
The order a waterfall column’s rows would walk for a provider choice, as of now (your keys and plan included), and the most a row would cost, two checks a row where the column’s second check is on. Saves nothing.
POST
/
provider-keys
/
enrichments
/
{action_key}
/
providers
/
preview
/
Preview a provider order
curl --request POST \
--url https://api.getoneprofile.ai/provider-keys/enrichments/{action_key}/providers/preview/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"providers": {
"preset": "recommended",
"steps": [
{
"integration_type": "<string>",
"operation_key": "<string>",
"enabled": true,
"fields": [
"<string>"
],
"pay_with": "credits"
}
]
},
"second_check": false
}
'import requests
url = "https://api.getoneprofile.ai/provider-keys/enrichments/{action_key}/providers/preview/"
payload = {
"providers": {
"preset": "recommended",
"steps": [
{
"integration_type": "<string>",
"operation_key": "<string>",
"enabled": True,
"fields": ["<string>"],
"pay_with": "credits"
}
]
},
"second_check": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
providers: {
preset: 'recommended',
steps: [
{
integration_type: '<string>',
operation_key: '<string>',
enabled: true,
fields: ['<string>'],
pay_with: 'credits'
}
]
},
second_check: false
})
};
fetch('https://api.getoneprofile.ai/provider-keys/enrichments/{action_key}/providers/preview/', 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.getoneprofile.ai/provider-keys/enrichments/{action_key}/providers/preview/",
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([
'providers' => [
'preset' => 'recommended',
'steps' => [
[
'integration_type' => '<string>',
'operation_key' => '<string>',
'enabled' => true,
'fields' => [
'<string>'
],
'pay_with' => 'credits'
]
]
],
'second_check' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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://api.getoneprofile.ai/provider-keys/enrichments/{action_key}/providers/preview/"
payload := strings.NewReader("{\n \"providers\": {\n \"preset\": \"recommended\",\n \"steps\": [\n {\n \"integration_type\": \"<string>\",\n \"operation_key\": \"<string>\",\n \"enabled\": true,\n \"fields\": [\n \"<string>\"\n ],\n \"pay_with\": \"credits\"\n }\n ]\n },\n \"second_check\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://api.getoneprofile.ai/provider-keys/enrichments/{action_key}/providers/preview/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"providers\": {\n \"preset\": \"recommended\",\n \"steps\": [\n {\n \"integration_type\": \"<string>\",\n \"operation_key\": \"<string>\",\n \"enabled\": true,\n \"fields\": [\n \"<string>\"\n ],\n \"pay_with\": \"credits\"\n }\n ]\n },\n \"second_check\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/provider-keys/enrichments/{action_key}/providers/preview/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"providers\": {\n \"preset\": \"recommended\",\n \"steps\": [\n {\n \"integration_type\": \"<string>\",\n \"operation_key\": \"<string>\",\n \"enabled\": true,\n \"fields\": [\n \"<string>\"\n ],\n \"pay_with\": \"credits\"\n }\n ]\n },\n \"second_check\": false\n}"
response = http.request(request)
puts response.read_body{
"max_credits_per_row": 123,
"runs_recommended": true,
"steps": [
{
"fields": [
"<string>"
],
"integration_type": "<string>",
"operation_key": "<string>",
"pay_with": "credits",
"price_credits": 123,
"provider_name": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Body
application/json
A provider choice to preview: what order the rows would walk and what a row costs.
Response
Successful Response
The order a choice resolves to for this workspace, and what a row costs at most.
Was this page helpful?