POST
/
v1
/
tables
Create Table
curl --request POST \
  --url https://api.extruct.ai/v1/tables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Supercharged Research",
  "kind": "company",
  "notify": false,
  "column_configs": [
    {
      "kind": "agent",
      "name": "Company Description",
      "key": "description",
      "value": {
        "agent_type": "research_pro",
        "prompt": "Research the company {company_name} ({company_website}) and provide a short description.",
        "output_format": "text"
      }
    }
  ]
}'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "kind": "generic",
  "notify": false,
  "settings": {
    "exclude_from_search": false
  },
  "columns": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "config": {
        "kind": "input",
        "name": "<string>",
        "key": "<string>"
      }
    }
  ],
  "owner": {
    "id": "<string>",
    "email": "<string>"
  },
  "child_relationships": [
    {
      "table_id": "<string>",
      "relationship_type": "company_people"
    }
  ],
  "parent_relationships": [
    {
      "table_id": "<string>",
      "relationship_type": "company_people"
    }
  ]
}

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
tags
string[] | null
kind
enum<string>
Available options:
generic,
company,
people
notify
boolean
default:false

Whether to notify the user when a table run completes with 5 minutes of inactivity.

settings
object | null

Table settings including blacklist configuration.

column_configs
(InputColumnConfig · object | AgentColumnConfig · object | CriterionGradeColumnConfig · object | PeopleFinderColumnConfig · object | DiscoveryScoresColumnConfig · object | CompanyNameColumnConfig · object | CompanyWebsiteColumnConfig · object | CompanyProfileColumnConfig · object)[] | null

Column configurations.

num_rows
integer | null

Optional number of rows to create. Rows created will be empty.

Response

Successful Response

id
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.

owner
object
required
description
string | null

Table description.

tags
string[] | null

Table tags.

notify
boolean
default:false

Whether to notify on table completion.

settings
object | null

Table settings including blacklist configuration.

child_relationships
TableRelationshipOutput · object[]

Child table relationships.

parent_relationships
TableRelationshipOutput · object[]

Parent table relationships.