Run a formula column

curl --request POST \
  --url https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/run/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "limit": 5000,
  "offset": 500000,
  "record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "record_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "sorts": [
    {
      "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "direction": "asc"
    }
  ],
  "where": {
    "items": [
      {
        "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "condition",
        "value": "<string>"
      }
    ],
    "joiner": "and"
  }
}
'

import requests

url = "https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/run/"

payload = {
    "limit": 5000,
    "offset": 500000,
    "record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "record_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "sorts": [
        {
            "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "direction": "asc"
        }
    ],
    "where": {
        "items": [
            {
                "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "type": "condition",
                "value": "<string>"
            }
        ],
        "joiner": "and"
    }
}
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({
    limit: 5000,
    offset: 500000,
    record_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    record_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    sorts: [{column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', direction: 'asc'}],
    where: {
      items: [
        {
          column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
          type: 'condition',
          value: '<string>'
        }
      ],
      joiner: 'and'
    }
  })
};

fetch('https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/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://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/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([
    'limit' => 5000,
    'offset' => 500000,
    'record_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'record_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'sorts' => [
        [
                'column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'direction' => 'asc'
        ]
    ],
    'where' => [
        'items' => [
                [
                                'column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                'type' => 'condition',
                                'value' => '<string>'
                ]
        ],
        'joiner' => 'and'
    ]
  ]),
  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/tables/{table_id}/columns/{column_id}/run/"

	payload := strings.NewReader("{\n  \"limit\": 5000,\n  \"offset\": 500000,\n  \"record_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"record_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"sorts\": [\n    {\n      \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"direction\": \"asc\"\n    }\n  ],\n  \"where\": {\n    \"items\": [\n      {\n        \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"type\": \"condition\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"joiner\": \"and\"\n  }\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/tables/{table_id}/columns/{column_id}/run/")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"limit\": 5000,\n  \"offset\": 500000,\n  \"record_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"record_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"sorts\": [\n    {\n      \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"direction\": \"asc\"\n    }\n  ],\n  \"where\": {\n    \"items\": [\n      {\n        \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"type\": \"condition\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"joiner\": \"and\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/run/")

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  \"limit\": 5000,\n  \"offset\": 500000,\n  \"record_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"record_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"sorts\": [\n    {\n      \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"direction\": \"asc\"\n    }\n  ],\n  \"where\": {\n    \"items\": [\n      {\n        \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"type\": \"condition\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"joiner\": \"and\"\n  }\n}"

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

{
  "run": {
    "cells_awaiting": 123,
    "cells_done": 123,
    "cells_failed": 123,
    "cells_no_data": 123,
    "cells_skipped": 123,
    "cells_total": 123,
    "completed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "error": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "row_scope": {
      "kind": "all_rows",
      "record_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "rows": 123
    },
    "started_at": "2023-11-07T05:31:56Z",
    "status": "pending",
    "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "trigger": "cell_edited",
    "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "column_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "credits_charged": 0,
    "export_retry_attempt": 0
  },
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

table-columns

Run a formula column

Request an on-demand recompute of one formula column: Run All, Run Errored, Run first N, or a single cell. all/errored/first_n share the column’s lineage workflow: a broader run supersedes a narrower in-flight one, and cells already computed under the same definition are freshness-skipped. cell runs are origin-keyed and independent. The response’s run is null while the workflow start is still queued (the run row is minted post-commit). The 2-second active-runs poll picks it up.

POST

tables

{table_id}

columns

{column_id}

run

Run a formula column

curl --request POST \
  --url https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/run/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "limit": 5000,
  "offset": 500000,
  "record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "record_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "sorts": [
    {
      "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "direction": "asc"
    }
  ],
  "where": {
    "items": [
      {
        "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "condition",
        "value": "<string>"
      }
    ],
    "joiner": "and"
  }
}
'

import requests

url = "https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/run/"

payload = {
    "limit": 5000,
    "offset": 500000,
    "record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "record_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "sorts": [
        {
            "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "direction": "asc"
        }
    ],
    "where": {
        "items": [
            {
                "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "type": "condition",
                "value": "<string>"
            }
        ],
        "joiner": "and"
    }
}
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({
    limit: 5000,
    offset: 500000,
    record_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    record_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    sorts: [{column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', direction: 'asc'}],
    where: {
      items: [
        {
          column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
          type: 'condition',
          value: '<string>'
        }
      ],
      joiner: 'and'
    }
  })
};

fetch('https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/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://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/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([
    'limit' => 5000,
    'offset' => 500000,
    'record_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'record_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'sorts' => [
        [
                'column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'direction' => 'asc'
        ]
    ],
    'where' => [
        'items' => [
                [
                                'column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                'type' => 'condition',
                                'value' => '<string>'
                ]
        ],
        'joiner' => 'and'
    ]
  ]),
  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/tables/{table_id}/columns/{column_id}/run/"

	payload := strings.NewReader("{\n  \"limit\": 5000,\n  \"offset\": 500000,\n  \"record_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"record_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"sorts\": [\n    {\n      \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"direction\": \"asc\"\n    }\n  ],\n  \"where\": {\n    \"items\": [\n      {\n        \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"type\": \"condition\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"joiner\": \"and\"\n  }\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/tables/{table_id}/columns/{column_id}/run/")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"limit\": 5000,\n  \"offset\": 500000,\n  \"record_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"record_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"sorts\": [\n    {\n      \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"direction\": \"asc\"\n    }\n  ],\n  \"where\": {\n    \"items\": [\n      {\n        \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"type\": \"condition\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"joiner\": \"and\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/run/")

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  \"limit\": 5000,\n  \"offset\": 500000,\n  \"record_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"record_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"sorts\": [\n    {\n      \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"direction\": \"asc\"\n    }\n  ],\n  \"where\": {\n    \"items\": [\n      {\n        \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"type\": \"condition\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"joiner\": \"and\"\n  }\n}"

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

{
  "run": {
    "cells_awaiting": 123,
    "cells_done": 123,
    "cells_failed": 123,
    "cells_no_data": 123,
    "cells_skipped": 123,
    "cells_total": 123,
    "completed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "error": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "row_scope": {
      "kind": "all_rows",
      "record_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "rows": 123
    },
    "started_at": "2023-11-07T05:31:56Z",
    "status": "pending",
    "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "trigger": "cell_edited",
    "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "column_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "credits_charged": 0,
    "export_retry_attempt": 0
  },
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

X-API-Key

string

header

required

Path Parameters

table_id

string<uuid>

required

column_id

string<uuid>

required

Body

application/json

Scope for an on-demand recompute of one formula column.

scope

enum<string>

required

Row scope: all | errored | unfilled | first_n | cell.

Available options:

all,

errored,

unfilled,

first_n,

cell

limit

integer | null

Row count for scope=first_n (default 10).

Required range: 1 <= x <= 10000

offset

integer | null

Starting-row offset in display order for scope=first_n; omit to start at the first row.

Required range: 0 <= x <= 1000000

record_id

string<uuid> | null

The target row for scope=cell; see also record_ids.

record_ids

string<uuid>[] | null

The target rows for scope=cell: a swept selection re-runs in one request rather than one per cell. Wins over record_id when both are sent; scope=cell requires at least one of the two.

Maximum array length: 1000

row_status

enum<string> | null

The grid's active smart view (errored or fully computed rows). ANDed with where.

Available options:

errored,

fully_computed

sorts

TableRowSortSchema · object[] | null

The grid's active sort, so first_n means the first N rows the person can SEE rather than the first N in stored order. Ignored by every other scope.

Maximum array length: 8

Show child attributes

where

TableRowsWhereSchema · object | null

The grid's active filter, in the rows query's own vocabulary. Narrows every scope but cell to the matching rows: all runs every matching row (as an explicit list, so at most view_scope_max_rows may match), errored / unfilled keep only matching rows, first_n counts within them. Omit for the whole table.

Show child attributes

Response

Successful Response

Result of requesting an on-demand column run.

run is None when the workflow start is still queued (the run row is minted post-commit). The frontend's 2-second active-runs poll picks it up.

run

TableRunReadSchema · object | null

required

A table recompute run with its static denominator and monotone counters.

Show child attributes

request_id

string<uuid> | null

The id of this run request. The run is minted with it as its origin, so it is known at once, even while run is still null.

API reference

Endpoints

Run a formula column

Authorizations

Path Parameters

Body

Response