Create Table

POST

tables

Create Table

curl --request POST \
  --url https://api.extruct.ai/v1/tables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Untitled Table",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "kind": "company",
  "column_configs": [
    {
      "name": "<string>",
      "key": "<string>",
      "kind": "input"
    }
  ]
}
'

import requests

url = "https://api.extruct.ai/v1/tables"

payload = {
    "name": "Untitled Table",
    "description": "<string>",
    "tags": ["<string>"],
    "kind": "company",
    "column_configs": [
        {
            "name": "<string>",
            "key": "<string>",
            "kind": "input"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Untitled Table',
    description: '<string>',
    tags: ['<string>'],
    kind: 'company',
    column_configs: [{name: '<string>', key: '<string>', kind: 'input'}]
  })
};

fetch('https://api.extruct.ai/v1/tables', 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.extruct.ai/v1/tables",
  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([
    'name' => 'Untitled Table',
    'description' => '<string>',
    'tags' => [
        '<string>'
    ],
    'kind' => 'company',
    'column_configs' => [
        [
                'name' => '<string>',
                'key' => '<string>',
                'kind' => 'input'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.extruct.ai/v1/tables"

	payload := strings.NewReader("{\n  \"name\": \"Untitled Table\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"kind\": \"company\",\n  \"column_configs\": [\n    {\n      \"name\": \"<string>\",\n      \"key\": \"<string>\",\n      \"kind\": \"input\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.extruct.ai/v1/tables")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Untitled Table\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"kind\": \"company\",\n  \"column_configs\": [\n    {\n      \"name\": \"<string>\",\n      \"key\": \"<string>\",\n      \"kind\": \"input\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extruct.ai/v1/tables")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Untitled Table\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"kind\": \"company\",\n  \"column_configs\": [\n    {\n      \"name\": \"<string>\",\n      \"key\": \"<string>\",\n      \"kind\": \"input\"\n    }\n  ]\n}"

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

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "columns": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "config": {
        "name": "<string>",
        "key": "<string>",
        "kind": "input"
      }
    }
  ],
  "owner": {
    "id": "<string>",
    "email": "<string>"
  },
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "child_relationships": [
    {
      "table_id": "<string>",
      "relationship_type": "company_people"
    }
  ],
  "parent_relationships": [
    {
      "table_id": "<string>",
      "relationship_type": "company_people"
    }
  ]
}

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

Overview

This endpoint creates a table for reusable enrichment or scoring workflows. You can populate it with companies discovered in Extruct or with your own list. kind determines what the table is for:

Use company when rows represent companies you want to enrich, score, or review.
Use people when rows represent contacts or individual people.
Use generic only when rows do not fit either company or people workflows.

Create the table first when you want a stable workspace for rows, columns, and runs, even if you are not ready to populate it yet.

Example request

export EXTRUCT_API_TOKEN="YOUR_API_TOKEN"

curl -X POST "https://api.extruct.ai/v1/tables" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${EXTRUCT_API_TOKEN}" \
  -d '{
    "name": "Company Research",
    "kind": "company",
    "column_configs": [
      {"kind": "input", "name": "Company", "key": "input"}
    ]
  }'

Key parameters

name (optional): defaults to Untitled Table.
kind (optional): generic, company, or people.
column_configs (optional): initial column definitions.

Success signal

A successful response includes a table id. Reuse this value as {table_id} in all table endpoints.

Common errors

`401 Unauthorized`

Check that your header is Authorization: Bearer ${EXTRUCT_API_TOKEN}.

`422 Unprocessable Entity`

Most often caused by invalid column_configs shape.

AI Tables Basics

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name

string

default:Untitled Table

description

string | null

Response

Successful Response

string

required

Table ID.

created_at

string<date-time>

required

Table creation time.

name

string

required

Table name.

kind

enum<string>

required

Table type.

Available options:

generic,

company,

people

columns

ColumnOutputSchema · object[]

required

Table columns configurations.

Show child attributes

owner

OwnerInfo · object

required

Show child attributes

description

string | null

Table description.

tags

string[] | null

Table tags.

child_relationships

TableRelationshipOutput · object[]

Child table relationships.

Show child attributes

parent_relationships

TableRelationshipOutput · object[]

Parent table relationships.

Show child attributes

Create Table

curl --request POST \
  --url https://api.extruct.ai/v1/tables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Untitled Table",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "kind": "company",
  "column_configs": [
    {
      "name": "<string>",
      "key": "<string>",
      "kind": "input"
    }
  ]
}
'

import requests

url = "https://api.extruct.ai/v1/tables"

payload = {
    "name": "Untitled Table",
    "description": "<string>",
    "tags": ["<string>"],
    "kind": "company",
    "column_configs": [
        {
            "name": "<string>",
            "key": "<string>",
            "kind": "input"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Untitled Table',
    description: '<string>',
    tags: ['<string>'],
    kind: 'company',
    column_configs: [{name: '<string>', key: '<string>', kind: 'input'}]
  })
};

fetch('https://api.extruct.ai/v1/tables', 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.extruct.ai/v1/tables",
  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([
    'name' => 'Untitled Table',
    'description' => '<string>',
    'tags' => [
        '<string>'
    ],
    'kind' => 'company',
    'column_configs' => [
        [
                'name' => '<string>',
                'key' => '<string>',
                'kind' => 'input'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.extruct.ai/v1/tables"

	payload := strings.NewReader("{\n  \"name\": \"Untitled Table\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"kind\": \"company\",\n  \"column_configs\": [\n    {\n      \"name\": \"<string>\",\n      \"key\": \"<string>\",\n      \"kind\": \"input\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.extruct.ai/v1/tables")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Untitled Table\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"kind\": \"company\",\n  \"column_configs\": [\n    {\n      \"name\": \"<string>\",\n      \"key\": \"<string>\",\n      \"kind\": \"input\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extruct.ai/v1/tables")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Untitled Table\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"kind\": \"company\",\n  \"column_configs\": [\n    {\n      \"name\": \"<string>\",\n      \"key\": \"<string>\",\n      \"kind\": \"input\"\n    }\n  ]\n}"

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

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "columns": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "config": {
        "name": "<string>",
        "key": "<string>",
        "kind": "input"
      }
    }
  ],
  "owner": {
    "id": "<string>",
    "email": "<string>"
  },
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "child_relationships": [
    {
      "table_id": "<string>",
      "relationship_type": "company_people"
    }
  ],
  "parent_relationships": [
    {
      "table_id": "<string>",
      "relationship_type": "company_people"
    }
  ]
}

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

API Reference

Company Search

Deep Search

Deep Research

Table Management

Table Execution

Other

Overview

Example request

Key parameters

Success signal

Common errors

`401 Unauthorized`

`422 Unprocessable Entity`

Authorizations

Body

Response

​Overview

​Example request

​Key parameters

​Success signal

​Common errors

​401 Unauthorized

​422 Unprocessable Entity

​Related endpoints

​Related guides

Authorizations

Body

Response

Overview

Example request

Key parameters

Success signal

Common errors

`401 Unauthorized`

`422 Unprocessable Entity`

Related endpoints

Related guides