API References
MCP Server Instance
MCP Server Metadata
Function Calling with MCP
White Label OAuth
Sandbox
Self Hosted MCP Server
Individual OAuth
curl --request POST \
--url https://api.klavis.ai/sandbox/salesforce/{sandbox_id}/initialize \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"accounts": [
{
"Name": "<string>",
"Industry": "<string>",
"Type": "<string>",
"Phone": "<string>",
"Website": "<string>",
"AnnualRevenue": 1,
"NumberOfEmployees": 1,
"BillingStreet": "<string>",
"BillingCity": "<string>",
"BillingState": "<string>",
"BillingPostalCode": "<string>",
"BillingCountry": "<string>",
"Description": "<string>",
"Rating": "<string>"
}
],
"contacts": [
{
"LastName": "<string>",
"FirstName": "<string>",
"Email": "[email protected]",
"Phone": "<string>",
"MobilePhone": "<string>",
"Title": "<string>",
"Department": "<string>",
"AccountId": "<string>",
"MailingStreet": "<string>",
"MailingCity": "<string>",
"MailingState": "<string>",
"MailingPostalCode": "<string>",
"MailingCountry": "<string>",
"Description": "<string>",
"LeadSource": "<string>"
}
],
"opportunities": [
{
"Name": "<string>",
"StageName": "<string>",
"CloseDate": "<string>",
"Amount": 1,
"Probability": 50,
"AccountId": "<string>",
"Type": "<string>",
"LeadSource": "<string>",
"NextStep": "<string>",
"Description": "<string>"
}
],
"leads": [
{
"LastName": "<string>",
"Company": "<string>",
"FirstName": "<string>",
"Email": "[email protected]",
"Phone": "<string>",
"MobilePhone": "<string>",
"Title": "<string>",
"Status": "Open - Not Contacted",
"LeadSource": "<string>",
"Industry": "<string>",
"Rating": "<string>",
"Street": "<string>",
"City": "<string>",
"State": "<string>",
"PostalCode": "<string>",
"Country": "<string>",
"Website": "<string>",
"Description": "<string>",
"NumberOfEmployees": 1,
"AnnualRevenue": 1
}
],
"cases": [
{
"Subject": "<string>",
"Status": "New",
"Priority": "Medium",
"Origin": "<string>",
"Type": "<string>",
"Reason": "<string>",
"AccountId": "<string>",
"ContactId": "<string>",
"Description": "<string>",
"SuppliedEmail": "[email protected]",
"SuppliedName": "<string>",
"SuppliedPhone": "<string>"
}
],
"campaigns": [
{
"Name": "<string>",
"Type": "<string>",
"Status": "Planned",
"StartDate": "<string>",
"EndDate": "<string>",
"ExpectedRevenue": 1,
"BudgetedCost": 1,
"ActualCost": 1,
"Description": "<string>",
"IsActive": true
}
]
}
'{
"sandbox_id": "<string>",
"status": "idle",
"message": "<string>",
"records_created": {}
}Initialize salesforce sandbox with data
Initialize the sandbox with salesforce-specific data following the defined schema.
curl --request POST \
--url https://api.klavis.ai/sandbox/salesforce/{sandbox_id}/initialize \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"accounts": [
{
"Name": "<string>",
"Industry": "<string>",
"Type": "<string>",
"Phone": "<string>",
"Website": "<string>",
"AnnualRevenue": 1,
"NumberOfEmployees": 1,
"BillingStreet": "<string>",
"BillingCity": "<string>",
"BillingState": "<string>",
"BillingPostalCode": "<string>",
"BillingCountry": "<string>",
"Description": "<string>",
"Rating": "<string>"
}
],
"contacts": [
{
"LastName": "<string>",
"FirstName": "<string>",
"Email": "[email protected]",
"Phone": "<string>",
"MobilePhone": "<string>",
"Title": "<string>",
"Department": "<string>",
"AccountId": "<string>",
"MailingStreet": "<string>",
"MailingCity": "<string>",
"MailingState": "<string>",
"MailingPostalCode": "<string>",
"MailingCountry": "<string>",
"Description": "<string>",
"LeadSource": "<string>"
}
],
"opportunities": [
{
"Name": "<string>",
"StageName": "<string>",
"CloseDate": "<string>",
"Amount": 1,
"Probability": 50,
"AccountId": "<string>",
"Type": "<string>",
"LeadSource": "<string>",
"NextStep": "<string>",
"Description": "<string>"
}
],
"leads": [
{
"LastName": "<string>",
"Company": "<string>",
"FirstName": "<string>",
"Email": "[email protected]",
"Phone": "<string>",
"MobilePhone": "<string>",
"Title": "<string>",
"Status": "Open - Not Contacted",
"LeadSource": "<string>",
"Industry": "<string>",
"Rating": "<string>",
"Street": "<string>",
"City": "<string>",
"State": "<string>",
"PostalCode": "<string>",
"Country": "<string>",
"Website": "<string>",
"Description": "<string>",
"NumberOfEmployees": 1,
"AnnualRevenue": 1
}
],
"cases": [
{
"Subject": "<string>",
"Status": "New",
"Priority": "Medium",
"Origin": "<string>",
"Type": "<string>",
"Reason": "<string>",
"AccountId": "<string>",
"ContactId": "<string>",
"Description": "<string>",
"SuppliedEmail": "[email protected]",
"SuppliedName": "<string>",
"SuppliedPhone": "<string>"
}
],
"campaigns": [
{
"Name": "<string>",
"Type": "<string>",
"Status": "Planned",
"StartDate": "<string>",
"EndDate": "<string>",
"ExpectedRevenue": 1,
"BudgetedCost": 1,
"ActualCost": 1,
"Description": "<string>",
"IsActive": true
}
]
}
'{
"sandbox_id": "<string>",
"status": "idle",
"message": "<string>",
"records_created": {}
}Authorizations
Your Klavis AI API key.
Path Parameters
The unique sandbox identifier
Body
Complete Salesforce sandbox data structure with all supported objects
List of Salesforce accounts
Show child attributes
Show child attributes
Account name (required)
1 - 255Industry (e.g., Technology, Healthcare, Finance)
Account type (e.g., Customer, Prospect, Partner)
Phone number
40Website URL
255Annual revenue
x >= 0Number of employees
x >= 0Billing street address
255Billing city
40Billing state/province
80Billing postal code
20Billing country
80Account description
32000Account rating (e.g., Hot, Warm, Cold)
List of Salesforce contacts
Show child attributes
Show child attributes
Last name (required)
1 - 80First name
40Email address
Phone number
40Mobile phone number
40Job title
128Department
80Related account ID (18-char Salesforce ID)
Mailing street address
255Mailing city
40Mailing state/province
80Mailing postal code
20Mailing country
80Contact description
32000Lead source (e.g., Web, Phone Inquiry, Partner Referral)
List of Salesforce opportunities
Show child attributes
Show child attributes
Opportunity name (required)
1 - 120Sales stage (required, e.g., Prospecting, Qualification, Closed Won)
Close date (required, format: YYYY-MM-DD)
Opportunity amount
x >= 0Probability of closing (0-100)
0 <= x <= 100Related account ID (18-char Salesforce ID)
Opportunity type (e.g., New Business, Existing Business)
Lead source (e.g., Web, Phone Inquiry, Partner Referral)
Next step in the sales process
255Opportunity description
32000List of Salesforce leads
Show child attributes
Show child attributes
Last name (required)
1 - 80Company name (required)
1 - 255First name
40Email address
Phone number
40Mobile phone number
40Job title
128Lead status (e.g., Open, Contacted, Qualified)
Lead source (e.g., Web, Phone Inquiry, Partner Referral)
Industry (e.g., Technology, Healthcare, Finance)
Lead rating (e.g., Hot, Warm, Cold)
Street address
255City
40State/province
80Postal code
20Country
80Website URL
255Lead description
32000Number of employees
x >= 0Annual revenue
x >= 0List of Salesforce cases
Show child attributes
Show child attributes
Case subject (required)
1 - 255Case status (e.g., New, Working, Closed)
Priority (e.g., High, Medium, Low)
Case origin (e.g., Phone, Email, Web)
Case type (e.g., Problem, Question, Feature Request)
Case reason
Related account ID (18-char Salesforce ID)
Related contact ID (18-char Salesforce ID)
Case description
32000Supplied email address
Supplied name
80Supplied phone number
40List of Salesforce campaigns
Show child attributes
Show child attributes
Campaign name (required)
1 - 80Campaign type (e.g., Email, Webinar, Conference)
Campaign status (e.g., Planned, In Progress, Completed)
Start date (format: YYYY-MM-DD)
End date (format: YYYY-MM-DD)
Expected revenue
x >= 0Budgeted cost
x >= 0Actual cost
x >= 0Campaign description
32000Is campaign active
Response
Successful Response
Response model for sandbox initialization