Preview playtable field run
curl --request POST \
--url https://beta.getsales.io/playtables/v1/api/playtable-fields/preview-run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"playtable_sid": "<string>",
"object_sid": "<string>",
"type": "action_ai_research",
"payload": {
"prompt": "<string>",
"model": "<string>",
"options": [
"<string>"
],
"output_mapping": [
{
"path": "<string>",
"target": "<string>"
}
],
"web_search": true
},
"run_condition": {
"and": [
{}
]
}
}
'import requests
url = "https://beta.getsales.io/playtables/v1/api/playtable-fields/preview-run"
payload = {
"playtable_sid": "<string>",
"object_sid": "<string>",
"type": "action_ai_research",
"payload": {
"prompt": "<string>",
"model": "<string>",
"options": ["<string>"],
"output_mapping": [
{
"path": "<string>",
"target": "<string>"
}
],
"web_search": True
},
"run_condition": { "and": [{}] }
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
playtable_sid: '<string>',
object_sid: '<string>',
type: 'action_ai_research',
payload: {
prompt: '<string>',
model: '<string>',
options: ['<string>'],
output_mapping: [{path: '<string>', target: '<string>'}],
web_search: true
},
run_condition: {and: [{}]}
})
};
fetch('https://beta.getsales.io/playtables/v1/api/playtable-fields/preview-run', 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://beta.getsales.io/playtables/v1/api/playtable-fields/preview-run",
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([
'playtable_sid' => '<string>',
'object_sid' => '<string>',
'type' => 'action_ai_research',
'payload' => [
'prompt' => '<string>',
'model' => '<string>',
'options' => [
'<string>'
],
'output_mapping' => [
[
'path' => '<string>',
'target' => '<string>'
]
],
'web_search' => true
],
'run_condition' => [
'and' => [
[
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <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://beta.getsales.io/playtables/v1/api/playtable-fields/preview-run"
payload := strings.NewReader("{\n \"playtable_sid\": \"<string>\",\n \"object_sid\": \"<string>\",\n \"type\": \"action_ai_research\",\n \"payload\": {\n \"prompt\": \"<string>\",\n \"model\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"output_mapping\": [\n {\n \"path\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"web_search\": true\n },\n \"run_condition\": {\n \"and\": [\n {}\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<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://beta.getsales.io/playtables/v1/api/playtable-fields/preview-run")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"playtable_sid\": \"<string>\",\n \"object_sid\": \"<string>\",\n \"type\": \"action_ai_research\",\n \"payload\": {\n \"prompt\": \"<string>\",\n \"model\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"output_mapping\": [\n {\n \"path\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"web_search\": true\n },\n \"run_condition\": {\n \"and\": [\n {}\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/playtables/v1/api/playtable-fields/preview-run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"playtable_sid\": \"<string>\",\n \"object_sid\": \"<string>\",\n \"type\": \"action_ai_research\",\n \"payload\": {\n \"prompt\": \"<string>\",\n \"model\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"output_mapping\": [\n {\n \"path\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"web_search\": true\n },\n \"run_condition\": {\n \"and\": [\n {}\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": "<unknown>",
"result": {
"object_sid": "<string>",
"will_run": true,
"skip_reason": "<string>",
"value": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"reasoning": "<string>",
"confidence": "<string>",
"model": "<string>",
"credits_charged": 1,
"duration_ms": 1
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}playtable_fields
Preview playtable field run
Run an unsaved action_ai_research column against ONE row and answer what its cell would hold: before the column exists, or with the edited prompt of one that does (the drawer’s per-row Preview). The same gate, model resolution and output coercion as the paid run, so a preview never promises what the run refuses. PRICED AS ONE ROW: the platform’s charge comes back in credits_charged; a row the gate skips (will_run false, skip_reason run_condition_not_met or empty_context) costs nothing. Writes nothing: no cell, no run, no ledger receipt. Every call asks the model again with a fresh key, so a repeat may answer differently and is charged again. Read value, reasoning and confidence; error_code names a refusal before any charge (model_not_in_catalog, web_search_not_supported), a failed call, or an answer that could not be coerced to payload.output (the model ran and was paid). Show the user the sample and its cost; the whole column is create_playtable_run after estimate_playtable_run.
Contract:
- MCP tool
preview_playtable_field_run, registry packagemcp.playtables/playtable_fields, mountplaytables.columns. - Operation
action, response envelopeaction. - Flags: none.
POST
/
api
/
playtable-fields
/
preview-run
Preview playtable field run
curl --request POST \
--url https://beta.getsales.io/playtables/v1/api/playtable-fields/preview-run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"playtable_sid": "<string>",
"object_sid": "<string>",
"type": "action_ai_research",
"payload": {
"prompt": "<string>",
"model": "<string>",
"options": [
"<string>"
],
"output_mapping": [
{
"path": "<string>",
"target": "<string>"
}
],
"web_search": true
},
"run_condition": {
"and": [
{}
]
}
}
'import requests
url = "https://beta.getsales.io/playtables/v1/api/playtable-fields/preview-run"
payload = {
"playtable_sid": "<string>",
"object_sid": "<string>",
"type": "action_ai_research",
"payload": {
"prompt": "<string>",
"model": "<string>",
"options": ["<string>"],
"output_mapping": [
{
"path": "<string>",
"target": "<string>"
}
],
"web_search": True
},
"run_condition": { "and": [{}] }
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
playtable_sid: '<string>',
object_sid: '<string>',
type: 'action_ai_research',
payload: {
prompt: '<string>',
model: '<string>',
options: ['<string>'],
output_mapping: [{path: '<string>', target: '<string>'}],
web_search: true
},
run_condition: {and: [{}]}
})
};
fetch('https://beta.getsales.io/playtables/v1/api/playtable-fields/preview-run', 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://beta.getsales.io/playtables/v1/api/playtable-fields/preview-run",
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([
'playtable_sid' => '<string>',
'object_sid' => '<string>',
'type' => 'action_ai_research',
'payload' => [
'prompt' => '<string>',
'model' => '<string>',
'options' => [
'<string>'
],
'output_mapping' => [
[
'path' => '<string>',
'target' => '<string>'
]
],
'web_search' => true
],
'run_condition' => [
'and' => [
[
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <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://beta.getsales.io/playtables/v1/api/playtable-fields/preview-run"
payload := strings.NewReader("{\n \"playtable_sid\": \"<string>\",\n \"object_sid\": \"<string>\",\n \"type\": \"action_ai_research\",\n \"payload\": {\n \"prompt\": \"<string>\",\n \"model\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"output_mapping\": [\n {\n \"path\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"web_search\": true\n },\n \"run_condition\": {\n \"and\": [\n {}\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<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://beta.getsales.io/playtables/v1/api/playtable-fields/preview-run")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"playtable_sid\": \"<string>\",\n \"object_sid\": \"<string>\",\n \"type\": \"action_ai_research\",\n \"payload\": {\n \"prompt\": \"<string>\",\n \"model\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"output_mapping\": [\n {\n \"path\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"web_search\": true\n },\n \"run_condition\": {\n \"and\": [\n {}\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/playtables/v1/api/playtable-fields/preview-run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"playtable_sid\": \"<string>\",\n \"object_sid\": \"<string>\",\n \"type\": \"action_ai_research\",\n \"payload\": {\n \"prompt\": \"<string>\",\n \"model\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"output_mapping\": [\n {\n \"path\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"web_search\": true\n },\n \"run_condition\": {\n \"and\": [\n {}\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": "<unknown>",
"result": {
"object_sid": "<string>",
"will_run": true,
"skip_reason": "<string>",
"value": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"reasoning": "<string>",
"confidence": "<string>",
"model": "<string>",
"credits_charged": 1,
"duration_ms": 1
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}Authorizations
Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.
Team scope for tokens that do not carry one. Ignored when the token already names a team.
Body
application/json
Request body of preview_playtable_field_run.
Owner playtable sid (pt_tb_…).
Required string length:
18Pattern:
^pt_tb_The one row to try the draft on (cr_pp_… or cr_co_…), of this table and this team.
Required string length:
18What the draft column is. Only action_ai_research runs inline today: waterfall and tool columns run through the queued executor and have no preview.
Available options:
action_ai_research The drawer's live draft (prompt, model, output, options, output_mapping, web_search), validated exactly like create_playtable_field's: a payload that previews is a payload that saves.
Show child attributes
Show child attributes
run_condition
Option 1 · objectOption 2 · objectOption 3 · objectOption 4 · objectOption 5 · objectOption 6 · any
The draft gate; a row it skips costs nothing and answers will_run false. null or absent = no gate.
Show child attributes
Show child attributes
Response
action success envelope.