🧠 Create Project

POST /create/{{prefix}}

Creates a new Project under the specified prefix and returns a unique sense_id that can be used for linking services, queries, and resources.

🔍 Description

A Project acts as a container for connecting and organizing services, executing queries, and storing metadata. This endpoint allows you to create a new Project by providing a name and region.

🔐 Authentication

Requires a valid Bearer token in the Authorization header.

🧾 Path Parameters

📥 Request Body (application/json)

📦 Example Request Body

{
  "name": "Customers List",
  "region": "us-east-north-1"
}

📋 List Projects

POST /list/{{prefix}}?size={{size}}&page={{page}}

Retrieves a paginated list of Projects based on the provided list of sense_ids (super_ids). You can also apply optional filters.

🔍 Description

This endpoint returns metadata for multiple Projects identified by their super_ids. It supports pagination and future filtering options. Useful for displaying a list of active or relevant Projects under a given prefix.

🔐 Authentication

No authentication is required for this endpoint unless otherwise configured.

🧾 Path Parameters

🔍 Query Parameters

📥 Request Body (application/json)

📦 Example Request Body

{
  "super_ids": [
    "3b5516dd-1d69-49e5-8045-983a66026395",
    "579c43e4-1414-4c4e-9f11-345f5f6fc78c"
  ],
  "filters": []
}

🧩 Salesforce Integration API

POST /salesforce/{{prefix}}/{{sense_id}}

Connects to a Salesforce account using a refresh token and stores its schema under a specific Project.

🔍 Description

This endpoint allows you to integrate a Salesforce account by providing the refresh token and instance URL. It retrieves metadata (objects/schema) from Salesforce and stores both the connection and schema under the specified Project.

🔐 Authentication

No authentication required for this endpoint itself.
Salesforce credentials (refresh_token, instance_url) must be provided in the JSON body.

🧾 Path Parameters

📥 Request Body (application/json)

📦 Example Request Body

{
  "refresh_token": "your_salesforce_refresh_token",
  "instance_url": "https://your-instance.salesforce.com"
}

🤖 Query Execution API

POST /query/{{prefix}}/{{sense_id}}

Executes a structured query against an AI-powered data agent and returns the results based on the given instructions.

🔍 Description

This endpoint allows you to submit a natural language query (or system prompt) and enrich it with contextual modifications such as URL transformations or prefixing. The result is returned as a stream and typically formatted as a JSON array.

🔐 Authentication

Bearer token must be provided in the Authorization header.
This token authorizes the query execution for a specific session and user.

🧾 Path Parameters

📥 Form Data (multipart/form-data)

📦 Example Request Body

{
  "question": "Give me the list of cases in the past 24 hours. Respond ONLY with a clean JSON array, without any text. Each record should have fields: case_number, case subject, case_owner, and url.",
  "enrich_text": "prefix the url with https://supersense-demo.my.salesforce.com for records\nalso replace services/data/v59.0/sobject with lightning/r\nand tail it with \"/view\"",
  "session_id": "711b86bb-36f4-4eb4-9f0b-88a96cae1111"
}