The Super Sense API
\nThe Super Sense API is built on REST principles. It features predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON responses, and adheres to standard HTTP response codes and verbs.
\nThe Super Sense API utilizes a Bearer Token for authentication. This token must be included in the Authorization header for every request.
\nObtain Token:
Acquire a valid Bearer Token (API Token) from the Super Sense Console.
Authorization:
Include the Bearer Token in the Authorization header for each request as follows:
httpCopy codeAuthorization: Bearer <your-token-value>\n\nReplace with the actual token you received from the Super Sense Console.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10394989","collectionId":"b1c46ca0-29b1-4cbe-976c-b53b248144d6","publishedId":"2sAXjQ2AEk","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-09-05T11:23:56.000Z"},"item":[{"name":"Senses","item":[{"name":"Create","id":"a81210c9-7233-44fc-8c6c-a183809cbf5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\":\"Products Catalog\",\n \"region\":\"us-east-north-1\",\n \"tier\":1\n}","options":{"raw":{"language":"json"}}},"url":"https://api.super-sense.ai/create/{{prefix}}","description":"/create/{{prefix}}Creates a new Sense under the specified prefix and returns a unique sense_id that can be used for linking services, queries, and resources.
A Sense acts as a container for connecting and organizing services, executing queries, and storing metadata. This endpoint allows you to create a new Sense by providing a name and region.
\nRequires a valid Bearer token in the Authorization header.
{\n \"name\": \"Customers List\",\n \"region\": \"us-east-north-1\"\n}\n\n/list/{{prefix}}?size={{size}}&page={{page}}Retrieves a paginated list of Senses based on the provided list of sense_ids (super_ids). You can also apply optional filters.
This endpoint returns metadata for multiple Senses identified by their super_ids. It supports pagination and future filtering options. Useful for displaying a list of active or relevant Senses under a given prefix.
No authentication is required for this endpoint unless otherwise configured.
\n{\n \"super_ids\": [\n \"3b5516dd-1d69-49e5-8045-983a66026395\",\n \"579c43e4-1414-4c4e-9f11-345f5f6fc78c\"\n ],\n \"filters\": []\n}\n\nManage Super Senses
\n","_postman_id":"418d8b2a-d90f-4130-b55d-407d74442838"},{"name":"Sense Resources","item":[{"name":"List Resources","id":"a1ee2b6a-edd7-41a0-b7ca-2de750e2b290","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.super-sense.ai/resources/{{prefix}}/{{sense_id}}","urlObject":{"protocol":"https","path":["resources","{{prefix}}","{{sense_id}}"],"host":["api","super-sense","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"a1ee2b6a-edd7-41a0-b7ca-2de750e2b290"},{"name":"Resource","id":"ad6b9d3f-3a15-4ac1-807b-8f409b8e55a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{super_sense_sm_url}}/resources/07fb5e30-9cae-43fa-92b7-debd6c9e8892/12dd3060-17c3-40ae-b158-d1abcf4d7470/ce4735d7-f7d4-4bb9-9c0d-923ffa84e1d4","urlObject":{"path":["resources","07fb5e30-9cae-43fa-92b7-debd6c9e8892","12dd3060-17c3-40ae-b158-d1abcf4d7470","ce4735d7-f7d4-4bb9-9c0d-923ffa84e1d4"],"host":["{{super_sense_sm_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad6b9d3f-3a15-4ac1-807b-8f409b8e55a6"},{"name":"Connector - File","id":"d94a9bf8-fa97-4020-84e0-7f79c4e0fb8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/darleys/Downloads/280380-FEIN (3).pdf"],"value":null}]},"url":"https://api.super-sense.ai/upload/{{prefix}}/{{sense_id}}","urlObject":{"protocol":"https","path":["upload","{{prefix}}","{{sense_id}}"],"host":["api","super-sense","ai"],"query":[],"variable":[]}},"response":[{"id":"c9dd2447-0c04-40cb-9368-fc33c2cf3018","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{api_token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/Users/darleys/Downloads/LOA_ as45671_1.pdf"}]},"url":"https://api.super-sense.ai/upload/{{prefix}}/{{sense_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Fri, 16 Aug 2024 16:28:47 GMT"},{"key":"server","value":"uvicorn"},{"key":"content-length","value":"171"},{"key":"content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"File uploaded successfully and vector database created for super_id 54a10e78-0dc1-45ff-b58f-2b6393becdc0 and resource_id da3b5675-7a28-4bb2-bff0-da30aa93514e\"\n}"}],"_postman_id":"d94a9bf8-fa97-4020-84e0-7f79c4e0fb8b"},{"name":"Connector - Website","id":"c3ac9209-5799-4464-9897-067d99cdfdca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"url\":\"https://www.example.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.super-sense.ai/crawl/{{prefix}}/{{sense_id}}","urlObject":{"protocol":"https","path":["crawl","{{prefix}}","{{sense_id}}"],"host":["api","super-sense","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3ac9209-5799-4464-9897-067d99cdfdca"},{"name":"Connector - API","id":"2d8e7e0b-0055-4604-a8d6-d59e58b7299b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"type":"text","key":"auth","value":"{\"type\": \"bearer\", \"token\": \"your_token_here\"}"},{"type":"text","key":"name","value":"Test API Collection"},{"type":"file","contentType":"application/json","key":"collection","src":"/api/{{prefix}}/{{sense_id}}Uploads one or more API collections (e.g., OpenAPI/Swagger), validates the authentication method, and stores the parsed schema under a specific Sense.
\nThis endpoint allows users to upload one or more API specification files along with the corresponding authentication configuration. It parses and embeds the uploaded content, then stores it under a unique resource for the given Sense.
\nNo authentication required for this endpoint itself.
The auth field in the form should contain credentials and method type for the API being uploaded.
auth Field{\n \"type\": \"bearer\",\n \"token\": \"your_api_token_here\"\n}\n\n/bitbucket/{{prefix}}/{{sense_id}}Registers a Bitbucket connection and stores its schema under a specific Sense.
\nThis endpoint allows you to integrate a Bitbucket account (Cloud or Server) by providing basic authentication credentials and an optional schema. The data is securely stored in the system under the corresponding Sense identified by sense_id.
No authentication required for this endpoint itself.
Bitbucket credentials (username, api_token) are provided in the JSON body.
{\n \"base_url\": \"https://api.bitbucket.org\",\n \"username\": \"john_doe\",\n \"api_token\": \"bitbucket_app_password_123\",\n \"schema\": {\n \"repos\": [\"repo1\", \"repo2\"],\n \"metadata\": {\n \"source\": \"bitbucket\"\n }\n }\n}\n\n/jira/{{prefix}}/{{sense_id}}Connects a Jira account and stores its schema under a specific Sense.
\nThis endpoint allows you to integrate a Jira account (Cloud) by providing authentication credentials and an optional schema. The connection details and schema are securely stored and linked to the specified Sense.
\nNo authentication required for this endpoint itself.
Jira credentials (email, api_token) are provided in the JSON body.
{\n \"base_url\": \"https://your-domain.atlassian.net\",\n \"email\": \"user@example.com\",\n \"api_token\": \"your_jira_api_token\",\n \"schema\": {\n \"projects\": [\"PROJ-1\", \"PROJ-2\"]\n }\n}\n\n/mongodb/{{prefix}}/{{sense_id}}Connects to a MongoDB database using the provided connection string and stores its schema under a specific Sense.
\nThis endpoint allows you to connect to a MongoDB instance by providing a valid connection string. It retrieves the database schema, merges it with any optional schema definition provided in the request, and stores both under the specified Sense.
\nNo authentication required for this endpoint itself.
A valid MongoDB connection string must be provided in the request body.
{\n \"connection_string\": \"mongodb+srv://user:password@cluster0.mongodb.net/myDatabase?retryWrites=true&w=majority\",\n \"schema\": {\n \"description\": \"Customer and Orders collections\"\n }\n}\n\n/mysql/{{prefix}}/{{sense_id}}Connects to a MySQL database (with optional SSH tunneling) and stores its schema under a specific Sense.
\nThis endpoint allows you to connect to a MySQL database by providing direct or SSH-based connection details. It retrieves the database schema, optionally merges it with a custom schema definition, and stores both under the specified Sense.
\nNo authentication required for this endpoint itself.
MySQL and SSH credentials must be provided in the request body.
{\n \"host\": \"mysql.example.com\",\n \"port\": 3306,\n \"user\": \"admin\",\n \"password\": \"securepassword123\",\n \"database\": \"customer_data\",\n \"use_ssh\": true,\n \"ssh_host\": \"ssh.example.com\",\n \"ssh_user\": \"ec2-user\",\n \"ssh_password\": \"sshpass456\",\n \"ssh_port\": 22,\n \"schema\": {\n \"description\": \"Includes tables for customers, orders, and invoices\"\n }\n}\n\n/postgres/{{prefix}}/{{sense_id}}Connects to a PostgreSQL database (with optional SSH tunneling) and stores its schema under a specific Sense.
\nThis endpoint allows you to connect to a PostgreSQL database by providing direct or SSH-based connection details. It retrieves the database schema, optionally merges it with a custom schema definition, and stores both under the specified Sense.
\nNo authentication required for this endpoint itself.
PostgreSQL and SSH credentials must be provided in the request body.
{\n \"host\": \"postgres.example.com\",\n \"port\": 5432,\n \"user\": \"admin\",\n \"password\": \"securepassword123\",\n \"database\": \"analytics_db\",\n \"use_ssh\": true,\n \"ssh_host\": \"ssh.example.com\",\n \"ssh_user\": \"ec2-user\",\n \"ssh_password\": \"sshpass456\",\n \"ssh_port\": 22,\n \"schema\": {\n \"description\": \"PostgreSQL schema for analytics and reporting\"\n }\n}\n\n/salesforce/{{prefix}}/{{sense_id}}Connects to a Salesforce account using a refresh token and stores its schema under a specific Sense.
\nThis 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 Sense.
\nNo authentication required for this endpoint itself.
Salesforce credentials (refresh_token, instance_url) must be provided in the JSON body.
{\n \"refresh_token\": \"your_salesforce_refresh_token\",\n \"instance_url\": \"https://your-instance.salesforce.com\"\n}\n\n/shopify/{{prefix}}/{{sense_id}}Connects a Shopify store and stores its connection details under a specific Sense.
\nThis endpoint allows you to connect a Shopify store by providing the store URL and access token. It verifies the credentials by calling the Shopify API and stores the connection under the specified Sense.
\nNo authentication required for this endpoint itself.
Shopify credentials (shop_url, token) must be provided in the JSON body.
{\n \"shop_url\": \"myshop.myshopify.com\",\n \"token\": \"shpat_1234567890abcdef\"\n}\n\n/slack/{{prefix}}/{{sense_id}}Connects a Slack workspace and stores its connection details under a specific Sense.
\nThis endpoint allows you to connect a Slack workspace by providing an access token, team info, and optional schema. It saves Slack workspace metadata and connection credentials under the specified Sense.
\nNo authentication required for this endpoint itself.
Slack credentials (access_token, team.id) must be provided in the JSON body.
{\n \"access_token\": \"xoxb-1234567890-abcdef123456\",\n \"refresh_token\": \"optional-refresh-token\",\n \"team\": {\n \"id\": \"T123ABC456\",\n \"name\": \"Marketing Team\"\n },\n \"schema\": \"Tracks Slack channels and messages from the marketing team\"\n}\n\n/snowflake/{{prefix}}/{{sense_id}}Connects to a Snowflake account and stores its schema under a specific Sense.
\nThis endpoint allows you to integrate a Snowflake database by providing connection credentials. It fetches the schema from the specified database and schema context, optionally merges it with a custom definition, and stores the result under the given Sense.
\nNo authentication required for this endpoint itself.
Snowflake connection credentials must be provided in the JSON body.
{\n \"account\": \"xy12345.us-east-1\",\n \"user\": \"analytics_user\",\n \"password\": \"securePassword!\",\n \"database\": \"MARKETING\",\n \"conn_schema\": \"PUBLIC\",\n \"warehouse\": \"COMPUTE_WH\",\n \"schema\": {\n \"description\": \"Schema for marketing data pipelines\"\n }\n}\n\n/sqlserver/{{prefix}}/{{sense_id}}Connects to a Microsoft SQL Server database (with optional SSH tunneling) and stores its schema under a specific Sense.
\nThis endpoint allows you to connect to a Microsoft SQL Server database by providing connection details. It fetches the schema, optionally merges it with a user-provided definition, and stores the result under the specified Sense.
\nNo authentication required for this endpoint itself.
SQL Server and optional SSH credentials must be provided in the JSON body.
{\n \"host\": \"sqlserver.example.com\",\n \"port\": 1433,\n \"user\": \"sa\",\n \"password\": \"YourSecurePassword!\",\n \"database\": \"sales_db\",\n \"use_ssh\": true,\n \"ssh_host\": \"ssh.example.com\",\n \"ssh_user\": \"ec2-user\",\n \"ssh_password\": \"sshSecret123\",\n \"ssh_port\": 22,\n \"schema\": {\n \"description\": \"Contains sales data tables and reporting views\"\n }\n}\n\n/stripe/{{prefix}}/{{sense_id}}Connects to a Stripe account and stores its schema under a specific Sense.
\nThis endpoint allows you to connect a Stripe account by providing the secret key. It stores the connection and an optional schema description under the specified Sense.
\nNo authentication required for this endpoint itself.
Stripe secret key must be provided in the JSON body.
{\n \"secret_key\": \"sk_test_51NKxxxxxxxabcdef\",\n \"schema\": {\n \"description\": \"Stripe integration to track customers, invoices, and subscriptions\"\n }\n}\n\n/sheets/{{prefix}}/{{sense_id}}Uploads a CSV, TSV, or Excel file and stores the data in PostgreSQL tables under a specific Sense.
\nThis endpoint allows users to upload structured files like CSV, TSV, or Excel (XLS/XLSX). It parses the file, creates corresponding PostgreSQL tables, and stores the data. For Excel files, each sheet is stored in a separate table.
\nNo authentication required for this endpoint itself.
The file must be provided as multipart/form-data.
/query/{{prefix}}/{{sense_id}}Executes a structured query against an AI-powered data agent and returns the results based on the given instructions.
\nThis 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.
\nBearer token must be provided in the Authorization header.
This token authorizes the query execution for a specific session and user.
{\n \"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.\",\n \"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\\\"\",\n \"session_id\": \"711b86bb-36f4-4eb4-9f0b-88a96cae1111\"\n}\n\n