Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.supersonic.cv/llms.txt

Use this file to discover all available pages before exploring further.

Records are the rows in your object types. A company, a contact, a deal — each is a record with dynamic fields defined by its object type.

​
Tools

ToolDescriptionKey Params
records.listList records for an object typeobject_type_slug, filters, sort, page, page_size
records.getGet a single record by IDobject_type_slug, record_id
records.createCreate a new recordobject_type_slug, data
records.updateUpdate a record’s fieldsobject_type_slug, record_id, data
records.deleteSoft-delete a recordobject_type_slug, record_id
records.searchFull-text search across recordsquery, object_type_slug (optional)
records.linkCreate a relation between two recordsfrom_record_id, to_record_id
records.unlinkRemove a relation between two recordsfrom_record_id, to_record_id
records.bulk_createCreate multiple records at onceobject_type_slug, records
records.search searches across all object types by default. Pass object_type_slug to narrow results to a single type.

​
Examples

​
Create a company record

{
  "tool": "records.create",
  "params": {
    "object_type_slug": "companies",
    "data": {
      "Name": "Acme Corp",
      "Domain": "acme.com",
      "Industry": "Technology",
      "Employee Count": 250
    }
  }
}
Response: 
{
  "success": true,
  "data": {
    "id": "rec_8f3a1b2c",
    "object_type_slug": "companies",
    "data": {
      "Name": "Acme Corp",
      "Domain": "acme.com",
      "Industry": "Technology",
      "Employee Count": 250
    },
    "created_at": "2026-03-23T10:15:00Z"
  }
}

​
Search for records

{
  "tool": "records.search",
  "params": {
    "query": "acme",
    "object_type_slug": "companies"
  }
}

{
  "tool": "records.bulk_create",
  "params": {
    "object_type_slug": "contacts",
    "records": [
      {
        "data": {
          "Name": "Jane Smith",
          "Email": "jane@acme.com",
          "Title": "CEO"
        }
      },
      {
        "data": {
          "Name": "Bob Johnson",
          "Email": "bob@acme.com",
          "Title": "CTO"
        }
      }
    ]
  }
}