Upload one chunk of records

curl --request POST \
  --url https://api.getdialed.ai/flows/record-sets/{record_set_id}/records \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "chunk_index": 0,
  "records": [
    {
      "name": "Placeholder One",
      "phone": "+15555550100"
    },
    {
      "name": "Placeholder Two",
      "phone": "+15555550101"
    }
  ]
}
'

import requests

url = "https://api.getdialed.ai/flows/record-sets/{record_set_id}/records"

payload = {
    "chunk_index": 0,
    "records": [
        {
            "name": "Placeholder One",
            "phone": "+15555550100"
        },
        {
            "name": "Placeholder Two",
            "phone": "+15555550101"
        }
    ]
}
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({
    chunk_index: 0,
    records: [
      {name: 'Placeholder One', phone: '+15555550100'},
      {name: 'Placeholder Two', phone: '+15555550101'}
    ]
  })
};

fetch('https://api.getdialed.ai/flows/record-sets/{record_set_id}/records', 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.getdialed.ai/flows/record-sets/{record_set_id}/records",
  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([
    'chunk_index' => 0,
    'records' => [
        [
                'name' => 'Placeholder One',
                'phone' => '+15555550100'
        ],
        [
                'name' => 'Placeholder Two',
                'phone' => '+15555550101'
        ]
    ]
  ]),
  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.getdialed.ai/flows/record-sets/{record_set_id}/records"

	payload := strings.NewReader("{\n  \"chunk_index\": 0,\n  \"records\": [\n    {\n      \"name\": \"Placeholder One\",\n      \"phone\": \"+15555550100\"\n    },\n    {\n      \"name\": \"Placeholder Two\",\n      \"phone\": \"+15555550101\"\n    }\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.getdialed.ai/flows/record-sets/{record_set_id}/records")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"chunk_index\": 0,\n  \"records\": [\n    {\n      \"name\": \"Placeholder One\",\n      \"phone\": \"+15555550100\"\n    },\n    {\n      \"name\": \"Placeholder Two\",\n      \"phone\": \"+15555550101\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getdialed.ai/flows/record-sets/{record_set_id}/records")

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  \"chunk_index\": 0,\n  \"records\": [\n    {\n      \"name\": \"Placeholder One\",\n      \"phone\": \"+15555550100\"\n    },\n    {\n      \"name\": \"Placeholder Two\",\n      \"phone\": \"+15555550101\"\n    }\n  ]\n}"

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

{
  "chunk_index": 0,
  "inserted": 10000,
  "received_count": 10000,
  "record_set_id": "rs_0123456789abcdef",
  "records_received": 10000,
  "replay": false
}

{
  "detail": "Authentication required"
}

{
  "detail": "Admin role required"
}

{
  "detail": "Record set not found"
}

{
  "detail": "Record set is not open"
}

{
  "detail": "Request body exceeds 16777216 bytes"
}

{
  "detail": "Validation error"
}

{
  "detail": "Rate limit exceeded"
}

POST

record-sets

{record_set_id}

records

Upload one chunk of records

curl --request POST \
  --url https://api.getdialed.ai/flows/record-sets/{record_set_id}/records \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "chunk_index": 0,
  "records": [
    {
      "name": "Placeholder One",
      "phone": "+15555550100"
    },
    {
      "name": "Placeholder Two",
      "phone": "+15555550101"
    }
  ]
}
'

import requests

url = "https://api.getdialed.ai/flows/record-sets/{record_set_id}/records"

payload = {
    "chunk_index": 0,
    "records": [
        {
            "name": "Placeholder One",
            "phone": "+15555550100"
        },
        {
            "name": "Placeholder Two",
            "phone": "+15555550101"
        }
    ]
}
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({
    chunk_index: 0,
    records: [
      {name: 'Placeholder One', phone: '+15555550100'},
      {name: 'Placeholder Two', phone: '+15555550101'}
    ]
  })
};

fetch('https://api.getdialed.ai/flows/record-sets/{record_set_id}/records', 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.getdialed.ai/flows/record-sets/{record_set_id}/records",
  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([
    'chunk_index' => 0,
    'records' => [
        [
                'name' => 'Placeholder One',
                'phone' => '+15555550100'
        ],
        [
                'name' => 'Placeholder Two',
                'phone' => '+15555550101'
        ]
    ]
  ]),
  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.getdialed.ai/flows/record-sets/{record_set_id}/records"

	payload := strings.NewReader("{\n  \"chunk_index\": 0,\n  \"records\": [\n    {\n      \"name\": \"Placeholder One\",\n      \"phone\": \"+15555550100\"\n    },\n    {\n      \"name\": \"Placeholder Two\",\n      \"phone\": \"+15555550101\"\n    }\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.getdialed.ai/flows/record-sets/{record_set_id}/records")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"chunk_index\": 0,\n  \"records\": [\n    {\n      \"name\": \"Placeholder One\",\n      \"phone\": \"+15555550100\"\n    },\n    {\n      \"name\": \"Placeholder Two\",\n      \"phone\": \"+15555550101\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getdialed.ai/flows/record-sets/{record_set_id}/records")

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  \"chunk_index\": 0,\n  \"records\": [\n    {\n      \"name\": \"Placeholder One\",\n      \"phone\": \"+15555550100\"\n    },\n    {\n      \"name\": \"Placeholder Two\",\n      \"phone\": \"+15555550101\"\n    }\n  ]\n}"

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

{
  "chunk_index": 0,
  "inserted": 10000,
  "received_count": 10000,
  "record_set_id": "rs_0123456789abcdef",
  "records_received": 10000,
  "replay": false
}

{
  "detail": "Authentication required"
}

{
  "detail": "Admin role required"
}

{
  "detail": "Record set not found"
}

{
  "detail": "Record set is not open"
}

{
  "detail": "Request body exceeds 16777216 bytes"
}

{
  "detail": "Validation error"
}

{
  "detail": "Rate limit exceeded"
}

Authorizations

X-API-Key

string

header

required

Path Parameters

record_set_id

string

required

Body

application/json

One chunk of records for an open record set.

chunk_index is assigned by you, starting at 0, and is what makes the upload safe to retry: re-sending the same chunk_index with the same records is recognised as a repeat and inserts nothing, so a network failure mid-upload is resolved by simply sending the chunk again. The response tells you whether the chunk was new (replay: false) or already had been received (replay: true).

A row's position in the record set is chunk_index * chunk_size + offset, where offset is the record's position within this chunk. A short chunk in the middle of the upload therefore leaves a gap in the numbering, which is harmless: rows are processed by range and sealing validates the totals. If you would rather have no gaps, send full chunks and make the last one short.

Chunks may be sent in any order, and out-of-order or retried chunks do not change the record set's content hash.

chunk_index

integer

required

Zero-based index of this chunk within the record set.

Required range: x >= 0

records

Records · object[]

required

The chunk's records, in dial order. At most chunk_size of them, and each one below the per-record size limit.

Response

Successful Response

The outcome of one chunk upload.

records_received is how many records the chunk carried and inserted is how many of them were new. replay is true when this chunk index had already been received, in which case inserted is normally 0 and the record set's counters are unchanged. received_count is the record set's running total after this chunk, which is the number to pass as expected_count when every chunk has been sent.

record_set_id

string

required

chunk_index

integer

required

records_received

integer

required

inserted

integer

required

replay

boolean

required

received_count

integer

required

Create a record set Seal a record set

Overview

Endpoints

Upload one chunk of records

Authorizations

Path Parameters

Body

Response