Skip to main content
POST
/
sandbox
/
airtable
/
{sandbox_id}
/
initialize
Initialize airtable sandbox with data
curl --request POST \
  --url https://api.klavis.ai/sandbox/airtable/{sandbox_id}/initialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tables": [
    {
      "name": "<string>",
      "description": "<string>",
      "fields": [
        {
          "name": "<string>",
          "type": "<string>",
          "options": {}
        }
      ],
      "records": [
        {
          "fields": {}
        }
      ]
    }
  ]
}
'
{
  "sandbox_id": "<string>",
  "status": "idle",
  "message": "<string>",
  "records_created": {}
}

Authorizations

Authorization
string
header
required

Your Klavis AI API key.

Path Parameters

sandbox_id
string
required

The unique sandbox identifier

Body

application/json

Complete Airtable sandbox data structure.

Hierarchy:

  • Bases contain Tables
  • Tables contain Fields (schema) and Records (data)
  • Records contain field values

Note: For sandbox purposes, we typically work with a single base and multiple tables within it.

tables
AirtableTable · object[] | null

List of tables (simplified, assumes single base)

Response

Successful Response

Response model for sandbox initialization

sandbox_id
string
required

Sandbox identifier

status
enum<string>
required

Current status

Available options:
idle,
occupied
message
string
required

Initialization result message

records_created
Records Created · object

Count of records created per object type