Clay

https://university.clay.com/docs
Admin
Clay is a powerful data automation platform that enables users to find, enrich, transform, and...
Tokens:185,529
Snippets:3,300
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Rate Limiting Configuration

Source: https://university.clay.com/docs/http-api-integration-overview

Example configuration for setting request limits and duration.

```text
Request limit: 10  
Duration (ms): 1000
```

--------------------------------

### JSON Formatting Examples

Source: https://university.clay.com/docs/http-api-integration-overview

Common syntax errors and their correct counterparts for JSON request bodies.

```json
❌ Wrong: {"name": /Name Column}  
✅ Correct: {"name": "/Name Column"}  
  
❌ Wrong: {"name": "John" "age": 30}  
✅ Correct: {"name": "John", "age": 30}
```

--------------------------------

### Example SQL Import Query

Source: https://university.clay.com/docs/snowflake-integration

Use a standard SELECT statement to define the data structure to import into Clay.

```sql
SELECT    domain,  
    company_name,  
    total_sessions,  
    last_session_at,  
    trial_status,  
    engagement_score  
FROM your_database.your_schema.your_table_or_view  
```

--------------------------------

### AND Operator Formula Example

Source: https://university.clay.com/docs/logical-operators

Use the && operator to verify multiple conditions simultaneously, such as checking employee count and location.

```text
{{employee_count}} > 500 && {{location}} == "US"
```

--------------------------------

### Action: Get account

Source: https://university.clay.com/docs/nooks-integration

Look up a single Nooks account (company) by ID.

```APIDOC
## Action: Get account

### Description
Look up a single Nooks account (company) by ID.

### Inputs
- **Account ID** (string) - Required - The ID of the Nooks account (company) to look up.

### Outputs
- **Account ID** (string) - The account's Nooks ID.
- **Company name** (string) - The name of the company.
- **Company domain** (string) - The company's domain.
- **Employee count** (integer) - The number of employees at the company.
- **Company professional profile URL** (string) - The company's professional profile URL.
- **Description** (string) - A description of the company.
- **Created at** (string) - When the account was created in Nooks.
- **Updated at** (string) - When the account was last updated in Nooks.
```

--------------------------------

### Get YouTube uploaded videos

Source: https://university.clay.com/docs/modash-integration-overview

Pull the most recent videos from a YouTube channel.

```APIDOC
## Action: Get YouTube uploaded videos

### Description
Pull the most recent videos from a YouTube channel.

### Inputs
- **YouTube channel URL or channel ID** (string) - Required - e.g., https://www.youtube.com/@GrowWithClay or UCRwHGGFXRRDeuKXkpqgmYbA.

### Outputs
- **Channel URL** (string) - Full YouTube channel URL.
- **Videos** (array) - List of uploaded videos containing Video ID, Title, Thumbnail URL, Duration, Published ago, and View count.
- **Total video count** (integer) - Total number of videos on the channel.
- **More videos available** (boolean) - Whether additional videos can be fetched with pagination.
```

--------------------------------

### Action: Import lead to campaign

Source: https://university.clay.com/docs/emailbison-integration

Adds a lead from Clay into a designated EmailBison campaign.

```APIDOC
## Action: Import lead to campaign

### Description
Use this action to add qualified or updated leads from Clay into a designated EmailBison campaign for targeted outreach.

### Inputs
- **Email** (string) - Required - The email address of the lead to import into the campaign.
- **Campaign ID** (string) - Required - The unique identifier of the EmailBison campaign.

### Output
- **Success** (boolean) - Lead successfully added to the EmailBison campaign.
- **Lead ID** (string) - The unique identifier assigned to the lead in EmailBison.
- **Campaign ID** (string) - Confirmation of the campaign to which the lead was added.
```

--------------------------------

### Get TikTok video comments

Source: https://university.clay.com/docs/modash-integration-overview

Retrieves comments from a specific TikTok video.

```APIDOC
## Get TikTok video comments

### Description
Pull comments from a TikTok video into a table, with one row per comment.

### Inputs
- **TikTok video URL or video ID** (string) - Required - e.g., https://www.tiktok.com/@username/video/123456789 or 123456789.

### Outputs
- **Video ID** (string) - TikTok video ID.
- **Comment ID** (string) - Unique identifier for the comment.
- **Text** (string) - Comment text.
- **Created at** (integer) - Unix timestamp when the comment was posted.
- **Like count** (integer) - Number of likes on the comment.
- **Reply count** (integer) - Number of replies to the comment.
- **User** (object) - Commenter details, including User ID, Username, Nickname, and Avatar URL.
```

--------------------------------

### Action: Get user

Source: https://university.clay.com/docs/nooks-integration

Look up a Nooks user by email or CRM user ID.

```APIDOC
## Action: Get user

### Description
Look up a Nooks user by email or CRM user ID and return their Nooks user ID and details. Most useful for filling the Owner input on Enroll prospect in sequence.

### Inputs
- **Email** (string) - Optional - The email of the Nooks user to look up.
- **CRM user ID** (string) - Optional - The ID of the user in your connected CRM.

### Outputs
- **User ID** (string) - The user's Nooks ID.
- **Full name** (string) - The user's full name.
- **Email** (string) - The user's email address.
- **CRM user ID** (string) - The user's ID in your connected CRM.
- **Created at** (string) - When the user was created in Nooks.
- **Updated at** (string) - When the user was last updated in Nooks.
```

--------------------------------

### Handle registration response

Source: https://university.clay.com/docs/connect-to-clay-mcp

The server returns a 201 Created status with the client credentials. Store the client_secret immediately as it is not returned again.

```json
{  
 	"client_id": "cci_...",  
 	"client_secret": "ccs_...",  
 	"client_id_issued_at": 1769904000,  
 	"client_secret_expires_at": 0,  
 	"redirect_uris": ["<https://acme.example.com/oauth/callback>"],  
 	"grant_types": ["authorization_code", "refresh_token"],  
 	"token_endpoint_auth_method": "client_secret_basic",  
 	"scope": "mcp"  
}
```

--------------------------------

### Action: Create call prep notes

Source: https://university.clay.com/docs/octave-integration

Creates call prep notes tailored for each individual engagement, including background research, discovery questions, and objection handling.

```APIDOC
## Action: Create call prep notes

### Description
Create call prep notes tailored for each individual engagement, including background research, discovery questions, objection handling, and more.

### Parameters
- **Agent** (string) - Required - Select the Octave agent for creating call prep notes
- **Person's professional profile URL** (string) - Optional - LinkedIn profile URL of the person
- **Person's first name** (string) - Optional - First name of the target person
- **Person's job title** (string) - Optional - Current job title
- **Company domain** (string) - Optional - Website domain of the target company
- **Company name** (string) - Optional - Name of the target company
- **Runtime context** (string) - Optional - Additional context to guide the AI analysis
- **Additional parameters** (json) - Optional - Extra parameters in JSON format
```

--------------------------------

### Get TikTok video comments

Source: https://university.clay.com/docs/modash-integration-overview

Extract comments from a TikTok video, returned as an array.

```APIDOC
## Action: Get TikTok video comments

### Description
Extract comments from a TikTok video, returned as an array attached to the row.

### Inputs
- **TikTok video URL or video ID** (string) - Required - e.g., https://www.tiktok.com/@username/video/123456789 or 123456789.

### Outputs
- **Comments** (array) - List of comments containing Comment ID, Text, Video ID, Created at, Like count, Reply count, and User details.
```

--------------------------------

### Move Private Key File

Source: https://university.clay.com/docs/snowflake-integration

Copy the generated private key to a convenient location for the Clay connection setup.

```bash
cp ~/snowflake_key.p8 ~/Downloads/snowflake_key.p8  
```

--------------------------------

### Get Instagram post comments

Source: https://university.clay.com/docs/modash-integration-overview

Pull comments from an Instagram post or reel into a table.

```APIDOC
## Source: Get Instagram post comments

### Description
Pull comments from an Instagram post or reel into a table, with one row per comment.

### Inputs
- **Instagram post URL or shortcode** (string) - Required - e.g., "https://www.instagram.com/p/ABC123/" or "ABC123".

### Outputs
- **Comment Details** (object) - Includes Post URL, Comment ID, Text, Created at (Unix timestamp), Likes, Reply count, and User details.
```

--------------------------------

### JSON Request Body Configuration

Source: https://university.clay.com/docs/http-api-integration-overview

Example of a valid JSON request body using both static values and dynamic column references.

```json
{ "firstName": "/First Name Column", "lastName": "/Last Name Column", "email": "/Email Column", "score": /Score Column, "subscribed": true }
```

--------------------------------

### POST https://api.clay.com/v3/mcp

Source: https://university.clay.com/docs/connect-to-clay-mcp

Initializes an MCP session and performs subsequent tool operations.

```APIDOC
## POST https://api.clay.com/v3/mcp

### Description
Initializes an MCP session and executes MCP operations. The first call must be 'initialize'. Subsequent calls require the session ID provided in the response header.

### Method
POST

### Endpoint
https://api.clay.com/v3/mcp

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer <access_token>
- **Mcp-Session-Id** (string) - Optional - Required for subsequent calls after initialization

### Response
#### Success Response (200)
- **Mcp-Session-Id** (header) - The session identifier for subsequent requests
```

--------------------------------

### Action: Get sequence state

Source: https://university.clay.com/docs/nooks-integration

Look up a single Nooks sequence state (enrollment) by ID.

```APIDOC
## Action: Get sequence state

### Description
Look up a single Nooks sequence state (enrollment) by ID, including its current state, sequence, prospect, account, and current step.

### Inputs
- **Sequence state ID** (string) - Required - The ID of the Nooks sequence state (enrollment) to look up.
- **Include related records** (array) - Optional - Expand up to 3 related records inline. Choose from Sequence, Prospect, Creator, and Current step.

### Outputs
- **Sequence state ID** (string) - The enrollment's Nooks ID.
- **State** (string) - The current state of the enrollment.
- **Sequence ID** (string) - The Nooks ID of the sequence.
- **Prospect ID** (string) - The Nooks ID of the enrolled prospect.
- **Account ID** (string) - The Nooks ID of the prospect's account.
- **Current step ID** (string) - The Nooks ID of the step the prospect is currently on.
- **Creator ID** (string) - The Nooks ID of the user who created the enrollment.
- **Owner ID** (string) - The Nooks ID of the user who owns the enrollment.
- **Created at** (string) - When the enrollment was created.
- **Updated at** (string) - When the enrollment was last updated.
```

--------------------------------

### Get operating location count

Source: https://university.clay.com/docs/enigma-integration

Count the total number of operating locations a brand operates.

```APIDOC
## Action: Get operating location count

### Description
Count the total number of operating locations a brand operates.

### Parameters
#### Required
- **Company domain** (string) - Required if Company name is not provided.
- **Company name** (string) - Required if Company domain is not provided.

#### Optional
- **Street address 1** (string) - The first line of the company's street address (US only).
- **Street address 2** (string) - The second line of the company's street address (US only).
- **City** (string) - The city of the company (US only).
- **State** (string) - The state of the company (US only).
- **ZIP code** (string) - The ZIP code of the company (US only).

### Response
- **Operating location count** (integer) - The total number of operating locations associated with the brand.
```

--------------------------------

### Generate Snowflake Key Pair

Source: https://university.clay.com/docs/snowflake-integration

Run these commands in your terminal to create the private and public key files required for authentication.

```bash
openssl genrsa 2048 | openssl pkcs8 -topk8 -nocrypt -out snowflake_key.p8openssl rsa -in snowflake_key.p8 -pubout -out snowflake_key.pub  
```

--------------------------------

### Conditional Logic Examples for Data Validation

Source: https://university.clay.com/docs/conditional-statements

Common patterns for handling empty fields, boundary values, and unexpected data formats.

```text
IF({{company_size}} > 100) THEN "Qualified" ELSE "Not Qualified"
```

```text
IF({{company_size}} >= 50) THEN "Medium" ELSE "Small"
```
Tokens:
Raw