Estimate playtable run cost

curl --request POST \
  --url https://beta.getsales.io/playtables/v1/api/playtable-runs/estimate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Team-SID: <api-key>' \
  --data '
{
  "playtable_sid": "<string>",
  "field_sids": [
    "<string>"
  ],
  "scope": {
    "object_sids": [
      "<string>"
    ],
    "view_sid": "<string>",
    "exclude_object_sids": [
      "<string>"
    ],
    "filter": {
      "and": [
        {}
      ]
    }
  },
  "type": "enrich",
  "force_rerun": true
}
'

import requests

url = "https://beta.getsales.io/playtables/v1/api/playtable-runs/estimate"

payload = {
    "playtable_sid": "<string>",
    "field_sids": ["<string>"],
    "scope": {
        "object_sids": ["<string>"],
        "view_sid": "<string>",
        "exclude_object_sids": ["<string>"],
        "filter": { "and": [{}] }
    },
    "type": "enrich",
    "force_rerun": True
}
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>',
    field_sids: ['<string>'],
    scope: {
      object_sids: ['<string>'],
      view_sid: '<string>',
      exclude_object_sids: ['<string>'],
      filter: {and: [{}]}
    },
    type: 'enrich',
    force_rerun: true
  })
};

fetch('https://beta.getsales.io/playtables/v1/api/playtable-runs/estimate', 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-runs/estimate",
  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>',
    'field_sids' => [
        '<string>'
    ],
    'scope' => [
        'object_sids' => [
                '<string>'
        ],
        'view_sid' => '<string>',
        'exclude_object_sids' => [
                '<string>'
        ],
        'filter' => [
                'and' => [
                                [
                                                                
                                ]
                ]
        ]
    ],
    'type' => 'enrich',
    'force_rerun' => true
  ]),
  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-runs/estimate"

	payload := strings.NewReader("{\n  \"playtable_sid\": \"<string>\",\n  \"field_sids\": [\n    \"<string>\"\n  ],\n  \"scope\": {\n    \"object_sids\": [\n      \"<string>\"\n    ],\n    \"view_sid\": \"<string>\",\n    \"exclude_object_sids\": [\n      \"<string>\"\n    ],\n    \"filter\": {\n      \"and\": [\n        {}\n      ]\n    }\n  },\n  \"type\": \"enrich\",\n  \"force_rerun\": true\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-runs/estimate")
  .header("Authorization", "Bearer <token>")
  .header("Team-SID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"playtable_sid\": \"<string>\",\n  \"field_sids\": [\n    \"<string>\"\n  ],\n  \"scope\": {\n    \"object_sids\": [\n      \"<string>\"\n    ],\n    \"view_sid\": \"<string>\",\n    \"exclude_object_sids\": [\n      \"<string>\"\n    ],\n    \"filter\": {\n      \"and\": [\n        {}\n      ]\n    }\n  },\n  \"type\": \"enrich\",\n  \"force_rerun\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://beta.getsales.io/playtables/v1/api/playtable-runs/estimate")

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  \"field_sids\": [\n    \"<string>\"\n  ],\n  \"scope\": {\n    \"object_sids\": [\n      \"<string>\"\n    ],\n    \"view_sid\": \"<string>\",\n    \"exclude_object_sids\": [\n      \"<string>\"\n    ],\n    \"filter\": {\n      \"and\": [\n        {}\n      ]\n    }\n  },\n  \"type\": \"enrich\",\n  \"force_rerun\": true\n}"

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

{
  "success": true,
  "operation": "action",
  "action": "<string>",
  "item": "<unknown>",
  "result": {
    "rows_matched": 123,
    "cost_min": 123,
    "cost_max": 123,
    "cost_expected": 123,
    "currency": "credits",
    "priced_at": "<string>",
    "fields": [
      {
        "playtable_field_sid": "<string>",
        "rows_to_run": 123,
        "cost_min": 123,
        "cost_max": 123,
        "cost_expected": 123,
        "steps": [
          {
            "tool_sid": "<string>",
            "price_min": 123,
            "price_max": 123
          }
        ]
      }
    ]
  },
  "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_runs

Estimate playtable run cost

Dry-run pricing for an enrich run - THE money-honesty gate (§4.6): call it BEFORE any paid create_playtable_run(type:“enrich”) and surface the range to the user. Resolves the scope row count per field (ES run_condition prefilter - approximate by design, the worker re-checks per cell; done cells are skipped unless force_rerun:true = re-charge consent; cells:not_run | error prices only the cells that have not run or only the error ones) and prices each field’s materialized waterfall from the cached gtm-api tool registry.

Returns rows_matched, cost_min (every row succeeds on the cheapest step), cost_max (full waterfall at max prices), cost_expected (registry expected path), priced_at, and a per-field breakdown with per-step price ranges - pass cost_max as max_budget at create (cost_expected is a midpoint, not a cap). No writes, no charges - free to call; free run types (export|import|bulk) have nothing to estimate. Also the answer to “what would it cost to …” - estimate only, no run. A view/filter scope is priced by count (rows_matched = the ES count; rows_to_run per field subtracts the rows already done unless force_rerun, or counts the error rows by id under cells), so any size prices instantly and rows_matched is never a truncated number.

Contract:

MCP tool estimate_playtable_run, registry package mcp.playtables/playtable_runs, mount playtables.columns.
Operation action, response envelope action.
Flags: read only.

POST

api

playtable-runs

estimate

Estimate playtable run cost

curl --request POST \
  --url https://beta.getsales.io/playtables/v1/api/playtable-runs/estimate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Team-SID: <api-key>' \
  --data '
{
  "playtable_sid": "<string>",
  "field_sids": [
    "<string>"
  ],
  "scope": {
    "object_sids": [
      "<string>"
    ],
    "view_sid": "<string>",
    "exclude_object_sids": [
      "<string>"
    ],
    "filter": {
      "and": [
        {}
      ]
    }
  },
  "type": "enrich",
  "force_rerun": true
}
'

import requests

url = "https://beta.getsales.io/playtables/v1/api/playtable-runs/estimate"

payload = {
    "playtable_sid": "<string>",
    "field_sids": ["<string>"],
    "scope": {
        "object_sids": ["<string>"],
        "view_sid": "<string>",
        "exclude_object_sids": ["<string>"],
        "filter": { "and": [{}] }
    },
    "type": "enrich",
    "force_rerun": True
}
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>',
    field_sids: ['<string>'],
    scope: {
      object_sids: ['<string>'],
      view_sid: '<string>',
      exclude_object_sids: ['<string>'],
      filter: {and: [{}]}
    },
    type: 'enrich',
    force_rerun: true
  })
};

fetch('https://beta.getsales.io/playtables/v1/api/playtable-runs/estimate', 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-runs/estimate",
  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>',
    'field_sids' => [
        '<string>'
    ],
    'scope' => [
        'object_sids' => [
                '<string>'
        ],
        'view_sid' => '<string>',
        'exclude_object_sids' => [
                '<string>'
        ],
        'filter' => [
                'and' => [
                                [
                                                                
                                ]
                ]
        ]
    ],
    'type' => 'enrich',
    'force_rerun' => true
  ]),
  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-runs/estimate"

	payload := strings.NewReader("{\n  \"playtable_sid\": \"<string>\",\n  \"field_sids\": [\n    \"<string>\"\n  ],\n  \"scope\": {\n    \"object_sids\": [\n      \"<string>\"\n    ],\n    \"view_sid\": \"<string>\",\n    \"exclude_object_sids\": [\n      \"<string>\"\n    ],\n    \"filter\": {\n      \"and\": [\n        {}\n      ]\n    }\n  },\n  \"type\": \"enrich\",\n  \"force_rerun\": true\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-runs/estimate")
  .header("Authorization", "Bearer <token>")
  .header("Team-SID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"playtable_sid\": \"<string>\",\n  \"field_sids\": [\n    \"<string>\"\n  ],\n  \"scope\": {\n    \"object_sids\": [\n      \"<string>\"\n    ],\n    \"view_sid\": \"<string>\",\n    \"exclude_object_sids\": [\n      \"<string>\"\n    ],\n    \"filter\": {\n      \"and\": [\n        {}\n      ]\n    }\n  },\n  \"type\": \"enrich\",\n  \"force_rerun\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://beta.getsales.io/playtables/v1/api/playtable-runs/estimate")

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  \"field_sids\": [\n    \"<string>\"\n  ],\n  \"scope\": {\n    \"object_sids\": [\n      \"<string>\"\n    ],\n    \"view_sid\": \"<string>\",\n    \"exclude_object_sids\": [\n      \"<string>\"\n    ],\n    \"filter\": {\n      \"and\": [\n        {}\n      ]\n    }\n  },\n  \"type\": \"enrich\",\n  \"force_rerun\": true\n}"

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

{
  "success": true,
  "operation": "action",
  "action": "<string>",
  "item": "<unknown>",
  "result": {
    "rows_matched": 123,
    "cost_min": 123,
    "cost_max": 123,
    "cost_expected": 123,
    "currency": "credits",
    "priced_at": "<string>",
    "fields": [
      {
        "playtable_field_sid": "<string>",
        "rows_to_run": 123,
        "cost_min": 123,
        "cost_max": 123,
        "cost_expected": 123,
        "steps": [
          {
            "tool_sid": "<string>",
            "price_min": 123,
            "price_max": 123
          }
        ]
      }
    ]
  },
  "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

Authorization

string

header

required

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-SID

string

header

required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of estimate_playtable_run.

playtable_sid

string

required

Parent playtable sid (pt_tb_…).

Required string length: 18

Pattern: ^pt_tb_

object_type

enum<string>

required

Which tab the run would target: people | company.

Available options:

people,

company

field_sids

string[]

required

The fields that would run (pt_fd_…, 1..20; action columns only).

Required array length: 1 - 20 elements

Required string length: 18

Pattern: ^pt_fd_

scope

object

required

Same XOR rule as create: object_sids XOR view_sid/filter.

Show child attributes

type

enum<string>

The type of the run this prices: enrich, the one paid type, the same word create_playtable_run takes (export, import and bulk have nothing to estimate). Optional; any other word is a 422 here, before the create.

Available options:

enrich

force_rerun

boolean

Default false - count done cells as re-runnable (they would be re-charged).

cells

enum<string>

Price only the cells that have not run (not_run) or only the error cells (error); the same selection as params.cells on create.

Available options:

not_run,

error

Response

action success envelope.

success

enum<boolean>

required

Available options:

true

operation

enum<string>

required

Available options:

action

action

string

required

kebab-case verb; matches the route segment.

item

any

required

result

object

required

Show child attributes

Overview

Playtables API

Unibox API

Signals API

Integrations API

ID and Teams API

Estimate playtable run cost

Authorizations

Body

Response