{"info":{"_postman_id":"c7951116-439a-4044-a661-ee1e16910c1a","name":"SimplAI API Documentation","description":"

Introduction

SimplAI's APIs provide programmatic access to AI applications created on the SimplAI platform. These APIs are based on REST architecture and use basic HTTP request methods, accepting and returning data in JSON format.

Follow the steps outlined in the following sections to integrate with our APIs.

Getting Started

Open your SimplAI account and navigate to the left-hand panel.
\n
Click on Settings and then API Keys.
\n
Click on Generate API Key. Once generated, you will see your new API Key.
\n
Include this API key in the headers under the PIM-SID key when making requests to the APIs documented here.
\n

Chat and Tool APIs

To call the API, you will need your account's tenant ID, client ID, and application's object ID.

Open your SimplAI account and navigate to the left-hand panel.
\n
Go to Integrations and select your application.
\n
Navigate to APIs and Webhooks and then APIs.
\n
You will find the tenant ID, client ID, and object ID (e.g., tool ID, agent ID, workflow ID) here.
\n

Webhooks

Set up a webhook with SimplAI to receive updates on specific events.

Open your SimplAI account and navigate to the left-hand panel.
\n
Go to Integrations and select your application.
\n
Navigate to APIs and Webhooks and then Webhooks.
\n
Configure your webhook by selecting an event and entering the Webhook URL.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"35165122","collectionId":"c7951116-439a-4044-a661-ee1e16910c1a","publishedId":"2sA3QqfCLB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"602EDF"},"publishDate":"2025-05-15T12:47:24.000Z"},"item":[{"name":"Agent APIs","item":[{"name":"Chat Initiation","id":"ab44dd09-c96a-43b8-962e-c7bcb788aae5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-DEVICE-ID","value":"simplai"},{"key":"PIM-SID","value":""},{"key":"X-TENANT-ID","value":""},{"key":"X-USER-ID","value":""}],"body":{"mode":"raw","raw":"{ \"agent_id\":\"\",\n \"language_code\": \"EN\",\n \"source\": \"APP\",\n \"action\": \"START_SCREEN\",\n \"query\": {\n \"message\": \"Write a short essay on birds.\",\n \"message_type\": \"string\",\n \"message_category\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://edge-service.simplai.ai/interact/api/ve1/intract/agent/conversation","description":"

This endpoint makes an HTTP POST request to interact with the conversation API. The request should include a payload with the following parameters in the raw request body:

language_code (string): The language code for the conversation.
\n
source (string): The source of the conversation.
\n
agent_id (string): The ID of the agent.
\n
action (string): The action to be performed.
\n
query (object): An object containing the following parameters:
\n
- message (string): The message for the conversation.
  \n
- message_type (string): The type of the message.
  \n
- message_category (string): The category of the message.
  \n
\n

The response to the request will have a status code of 200 and a content type of application/json. The response body will contain the following fields:

result (object): An object containing the following parameters:
\n
- conversation_id (string): The ID of the conversation.
  \n
- message_id (string): The ID of the message.
  \n
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PIM-SID"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c7951116-439a-4044-a661-ee1e16910c1a","id":"c7951116-439a-4044-a661-ee1e16910c1a","name":"SimplAI API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["interact","api","ve1","intract","agent","conversation"],"host":["edge-service","simplai","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"ab44dd09-c96a-43b8-962e-c7bcb788aae5"},{"name":"Continue Previous Chat","id":"b6933511-f4b6-4d85-8ca6-7e8ba4909a7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-DEVICE-ID","value":"simplai"},{"key":"PIM-SID","value":""},{"key":"X-TENANT-ID","value":""},{"key":"X-USER-ID","value":""}],"body":{"mode":"raw","raw":"{ \"agent_id\":\"\",\n \"language_code\": \"EN\",\n \"source\": \"APP\",\n \"action\": \"START_SCREEN\",\n \"conversation_id\": \"\",\n \"query\": {\n \"message\": \"Explain how the previous essay can be improved\",\n \"message_type\": \"string\",\n \"message_category\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://edge-service.simplai.ai/interact/api/ve1/intract/agent/conversation","description":"

This endpoint makes an HTTP POST request to interact with the conversation API. The request should include a payload with the following parameters in the raw request body:

language_code (string): The language code for the conversation.
\n
source (string): The source of the conversation.
\n
agent_id (string): The ID of the agent.
\n
action (string): The action to be performed.
\n
conversation_id (string): The ID of the conversation.
\n
query (object): An object containing the following parameters:
\n
- message (string): The message for the conversation.
  \n
- message_type (string): The type of the message.
  \n
- message_category (string): The category of the message.
  \n
\n

The response to the request will have a status code of 200 and a content type of application/json. The response body will contain the following fields:

result (object): An object containing the following parameters:
\n
- conversation_id (string): The ID of the conversation.
  \n
- message_id (string): The ID of the message.
  \n
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PIM-SID"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c7951116-439a-4044-a661-ee1e16910c1a","id":"c7951116-439a-4044-a661-ee1e16910c1a","name":"SimplAI API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["interact","api","ve1","intract","agent","conversation"],"host":["edge-service","simplai","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"b6933511-f4b6-4d85-8ca6-7e8ba4909a7f"},{"name":"Get Result for Message ID","id":"eaefd331-327c-4e7d-b79e-537c9b80af84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-USER-ID","value":""},{"key":"X-TENANT-ID","value":""},{"key":"PIM-SID","value":""},{"key":"X-DEVICE-ID","value":"simplai"}],"url":"https://edge-service.simplai.ai/interact/api/v1/intract/conversation/fetchDetails?cId=&mId=","description":"

Fetch Conversation Details

This endpoint retrieves the details of a conversation based on the provided conversation ID (cId) and message ID (mId).

Request

Method: GET
\n
URL: https://edge-service.simplai.ai/interact/api/v1/intract/conversation/fetchDetails?cId=&mId=
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PIM-SID"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c7951116-439a-4044-a661-ee1e16910c1a","id":"c7951116-439a-4044-a661-ee1e16910c1a","name":"SimplAI API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["interact","api","v1","intract","conversation","fetchDetails"],"host":["edge-service","simplai","ai"],"query":[{"key":"cId","value":""},{"key":"mId","value":""}],"variable":[]}},"response":[],"_postman_id":"eaefd331-327c-4e7d-b79e-537c9b80af84"},{"name":"Get Full Conversation","id":"48a5e5c0-608d-4065-9da0-65fe936e3aaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-USER-ID","value":""},{"key":"X-TENANT-ID","value":""},{"key":"PIM-SID","value":""},{"key":"X-DEVICE-ID","value":"simplai"}],"url":"https://edge-service.simplai.ai/interact/api/ve1/intract/conversation/","description":"

This endpoint makes an HTTP GET request to retrieve conversation details for a specific user. The request should include the user ID as a query parameter. The response will be in JSON format and will contain details of the conversation, including the response, query, action, language code, query result, and message status.

Example:

GET https://edge-service-preprod.simplai.ai/interact/api/ve1/intract/conversation/7a518168-5c10-4816-9af1-5373e1664870?userId=1\n\n

Response:

{\n    \"result\": {\n        \"response\": [\n            {\n                \"created_at\": \"\",\n                \"updated_at\": \"\",\n                \"id\": \"\",\n                \"query\": {\n                    \"message\": \"\",\n                    \"message_type\": \"\",\n                    \"message_category\": \"\"\n                },\n                \"action\": \"\",\n                \"lang_code\": \"\",\n                \"query_result\": \"\",\n                \"sent_time\": \"\",\n                \"model_version\": \"\",\n                \"model_id\": \"\",\n                \"message_status\": 0,\n                \"cid\": \"\"\n            }\n        ]\n    }\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PIM-SID"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c7951116-439a-4044-a661-ee1e16910c1a","id":"c7951116-439a-4044-a661-ee1e16910c1a","name":"SimplAI API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["interact","api","ve1","intract","conversation",""],"host":["edge-service","simplai","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"48a5e5c0-608d-4065-9da0-65fe936e3aaa"},{"name":"List All Conversations for User","id":"8554623d-defc-4b27-b697-e420383934e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-USER-ID","value":""},{"key":"X-TENANT-ID","value":""},{"key":"PIM-SID","value":""},{"key":"X-DEVICE-ID","value":"simplai"}],"url":"https://edge-service.simplai.ai/interact/api/ve1/intract/conversation?size=20&sort=createdAt%2Cdesc&page=0","description":"

Get Conversation

This endpoint retrieves conversations based on the provided query parameters.

Request

Query Parameters

size (integer) - The number of conversations to retrieve.
sort (string) - Sort the conversations based on the specified field and order.
userId (string) - The ID of the user.
sellerId (string) - The ID of the seller.
sellerProfileId (string) - The profile ID of the seller.
page (integer) - The page number.

Example:

https://edge-service-preprod.simplai.ai/interact/api/ve1/intract/conversation?size=20&sort=createdAt,desc&userId=1&sellerId=1&sellerProfileId=1&page=0\n\n

Response

ok (boolean) - Indicates if the request was successful.
code (string) - The status code of the response.
result (object) - The result object containing the response array.
- response (array) - An array of conversation objects.
  - created_at (string) - The timestamp of when the conversation was created.
  - updated_at (string) - The timestamp of when the conversation was last updated.
  - message (string) - The message content of the conversation.
  - cid (string) - The ID of the conversation.
  \n
\n
totalElements (integer) - The total number of elements.
totalPages (integer) - The total number of pages.
size (integer) - The size of the response.
numberOfElements (integer) - The number of elements in the response.
number (integer) - The page number.
last (boolean) - Indicates if it is the last page.
first (boolean) - Indicates if it is the first page.
sorted (boolean) - Indicates if the response is sorted.
empty (boolean) - Indicates if the response is empty.

Example Response:

{\n  \"ok\": true,\n  \"code\": \"\",\n  \"result\": {\n    \"response\": [\n      {\n        \"created_at\": \"\",\n        \"updated_at\": \"\",\n        \"message\": \"\",\n        \"cid\": \"\"\n      }\n    ]\n  },\n  \"totalElements\": 0,\n  \"totalPages\": 0,\n  \"size\": 0,\n  \"numberOfElements\": 0,\n  \"number\": 0,\n  \"last\": true,\n  \"first\": true,\n  \"sorted\": true,\n  \"empty\": true\n}\n\n

The Chat APIs allow you to programmatically access agents on the SimplAI platform.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"65429efa-c985-4ab0-90e6-a34d195d944b"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"a688e50b-fdcf-4bd0-a536-7fdf0fea786e"}}],"_postman_id":"353a772e-63f7-42c3-94f9-b6be8cee1908","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PIM-SID"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c7951116-439a-4044-a661-ee1e16910c1a","id":"c7951116-439a-4044-a661-ee1e16910c1a","name":"SimplAI API Documentation","type":"collection"}}},{"name":"AI Chains APIs","item":[{"name":"Chat Initiation","id":"0e35dfe4-690e-4803-a21c-2d0c2c614fb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-DEVICE-ID","value":"simplai"},{"key":"PIM-SID","value":""},{"key":"X-TENANT-ID","value":""},{"key":"X-USER-ID","value":""}],"body":{"mode":"raw","raw":"{ \"workflow_id\":\"\",\n \"language_code\": \"EN\",\n \"source\": \"APP\",\n \"action\": \"START_SCREEN\",\n \"query\": {\n \"message\": \"Write a short essay on birds.\",\n \"message_type\": \"string\",\n \"message_category\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://edge-service.simplai.ai/interact/api/ve1/intract/ai-chain/conversation","description":"

This endpoint makes an HTTP POST request to interact with the conversation API. The request should include a payload with the following parameters in the raw request body:

language_code (string): The language code for the conversation.
\n
source (string): The source of the conversation.
\n
workflow_id (string): The ID of the AI Chain.
\n
action (string): The action to be performed.
\n
query (object): An object containing the following parameters:
\n
- message (string): The message for the conversation.
  \n
- message_type (string): The type of the message.
  \n
- message_category (string): The category of the message.
  \n
\n

The response to the request will have a status code of 200 and a content type of application/json. The response body will contain the following fields:

result (object): An object containing the following parameters:
\n
- conversation_id (string): The ID of the conversation.
  \n
- message_id (string): The ID of the message.
  \n
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PIM-SID"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c7951116-439a-4044-a661-ee1e16910c1a","id":"c7951116-439a-4044-a661-ee1e16910c1a","name":"SimplAI API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["interact","api","ve1","intract","ai-chain","conversation"],"host":["edge-service","simplai","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"0e35dfe4-690e-4803-a21c-2d0c2c614fb8"},{"name":"Continue Previous Chat","id":"ba13a43b-831e-4d7b-8377-99739aa184c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-DEVICE-ID","value":"simplai"},{"key":"PIM-SID","value":""},{"key":"X-TENANT-ID","value":""},{"key":"X-USER-ID","value":""}],"body":{"mode":"raw","raw":"{ \"workflow_id\":\"\",\n \"language_code\": \"EN\",\n \"source\": \"APP\",\n \"action\": \"START_SCREEN\",\n \"conversation_id\": \"\",\n \"query\": {\n \"message\": \"Explain how the previous essay can be improved\",\n \"message_type\": \"string\",\n \"message_category\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://edge-service.simplai.ai/interact/api/ve1/intract/ai-chain/conversation","description":"

This endpoint makes an HTTP POST request to interact with the conversation API. The request should include a payload with the following parameters in the raw request body:

language_code (string): The language code for the conversation.
\n
source (string): The source of the conversation.
\n
workflow_id (string): The ID of the AI Chain.
\n
action (string): The action to be performed.
\n
conversation_id (string): The ID of the conversation.
\n
query (object): An object containing the following parameters:
\n
- message (string): The message for the conversation.
  \n
- message_type (string): The type of the message.
  \n
- message_category (string): The category of the message.
  \n
\n

The response to the request will have a status code of 200 and a content type of application/json. The response body will contain the following fields:

result (object): An object containing the following parameters:
\n
- conversation_id (string): The ID of the conversation.
  \n
- message_id (string): The ID of the message.
  \n
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PIM-SID"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c7951116-439a-4044-a661-ee1e16910c1a","id":"c7951116-439a-4044-a661-ee1e16910c1a","name":"SimplAI API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["interact","api","ve1","intract","ai-chain","conversation"],"host":["edge-service","simplai","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba13a43b-831e-4d7b-8377-99739aa184c9"},{"name":"Get Result for Message ID","id":"1ebf7559-3d35-4fae-ada1-9360c523eb58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-USER-ID","value":""},{"key":"X-TENANT-ID","value":""},{"key":"PIM-SID","value":""},{"key":"X-DEVICE-ID","value":"simplai"}],"url":"https://edge-service.simplai.ai/interact/api/v1/intract/conversation/fetchDetails?cId=&mId=","description":"

Fetch Conversation Details

This endpoint retrieves the details of a conversation based on the provided conversation ID (cId) and message ID (mId).

Request

Method: GET
\n
URL: https://edge-service.simplai.ai/interact/api/v1/intract/conversation/fetchDetails?cId=&mId=
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PIM-SID"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c7951116-439a-4044-a661-ee1e16910c1a","id":"c7951116-439a-4044-a661-ee1e16910c1a","name":"SimplAI API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["interact","api","v1","intract","conversation","fetchDetails"],"host":["edge-service","simplai","ai"],"query":[{"key":"cId","value":""},{"key":"mId","value":""}],"variable":[]}},"response":[],"_postman_id":"1ebf7559-3d35-4fae-ada1-9360c523eb58"},{"name":"Get Full Conversation","id":"4d5cc2ca-0962-401b-9e82-5bdfa6c51b53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-USER-ID","value":""},{"key":"X-TENANT-ID","value":""},{"key":"PIM-SID","value":""},{"key":"X-DEVICE-ID","value":"simplai"}],"url":"https://edge-service.simplai.ai/interact/api/ve1/intract/conversation/","description":"

Example:

GET https://edge-service-preprod.simplai.ai/interact/api/ve1/intract/conversation/7a518168-5c10-4816-9af1-5373e1664870?userId=1\n\n

Response:

{\n    \"result\": {\n        \"response\": [\n            {\n                \"created_at\": \"\",\n                \"updated_at\": \"\",\n                \"id\": \"\",\n                \"query\": {\n                    \"message\": \"\",\n                    \"message_type\": \"\",\n                    \"message_category\": \"\"\n                },\n                \"action\": \"\",\n                \"lang_code\": \"\",\n                \"query_result\": \"\",\n                \"sent_time\": \"\",\n                \"model_version\": \"\",\n                \"model_id\": \"\",\n                \"message_status\": 0,\n                \"cid\": \"\"\n            }\n        ]\n    }\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PIM-SID"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c7951116-439a-4044-a661-ee1e16910c1a","id":"c7951116-439a-4044-a661-ee1e16910c1a","name":"SimplAI API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["interact","api","ve1","intract","conversation",""],"host":["edge-service","simplai","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"4d5cc2ca-0962-401b-9e82-5bdfa6c51b53"},{"name":"List All Conversations for User","id":"709b3e9e-fbb1-4487-8048-4c1096e9ef5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-USER-ID","value":""},{"key":"X-TENANT-ID","value":""},{"key":"PIM-SID","value":""},{"key":"X-DEVICE-ID","value":"simplai"}],"url":"https://edge-service.simplai.ai/interact/api/ve1/intract/conversation?size=20&sort=createdAt%2Cdesc&page=0","description":"

Get Conversation

This endpoint retrieves conversations based on the provided query parameters.

Request

Query Parameters

size (integer) - The number of conversations to retrieve.
sort (string) - Sort the conversations based on the specified field and order.
userId (string) - The ID of the user.
sellerId (string) - The ID of the seller.
sellerProfileId (string) - The profile ID of the seller.
page (integer) - The page number.

Example:

https://edge-service-preprod.simplai.ai/interact/api/ve1/intract/conversation?size=20&sort=createdAt,desc&userId=1&sellerId=1&sellerProfileId=1&page=0\n\n

Response

ok (boolean) - Indicates if the request was successful.
code (string) - The status code of the response.
result (object) - The result object containing the response array.
- response (array) - An array of conversation objects.
  - created_at (string) - The timestamp of when the conversation was created.
  - updated_at (string) - The timestamp of when the conversation was last updated.
  - message (string) - The message content of the conversation.
  - cid (string) - The ID of the conversation.
  \n
\n
totalElements (integer) - The total number of elements.
totalPages (integer) - The total number of pages.
size (integer) - The size of the response.
numberOfElements (integer) - The number of elements in the response.
number (integer) - The page number.
last (boolean) - Indicates if it is the last page.
first (boolean) - Indicates if it is the first page.
sorted (boolean) - Indicates if the response is sorted.
empty (boolean) - Indicates if the response is empty.

Example Response:

{\n  \"ok\": true,\n  \"code\": \"\",\n  \"result\": {\n    \"response\": [\n      {\n        \"created_at\": \"\",\n        \"updated_at\": \"\",\n        \"message\": \"\",\n        \"cid\": \"\"\n      }\n    ]\n  },\n  \"totalElements\": 0,\n  \"totalPages\": 0,\n  \"size\": 0,\n  \"numberOfElements\": 0,\n  \"number\": 0,\n  \"last\": true,\n  \"first\": true,\n  \"sorted\": true,\n  \"empty\": true\n}\n\n

The Chat APIs allow you to programmatically access AI Chains on the SimplAI platform.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"65429efa-c985-4ab0-90e6-a34d195d944b"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"a688e50b-fdcf-4bd0-a536-7fdf0fea786e"}}],"_postman_id":"df2b6322-171d-415f-b7fe-07918e059bb7","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PIM-SID"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c7951116-439a-4044-a661-ee1e16910c1a","id":"c7951116-439a-4044-a661-ee1e16910c1a","name":"SimplAI API Documentation","type":"collection"}}},{"name":"Tool APIs","item":[{"name":"Create Tool Run","id":"ccb4a527-755d-4814-9d0d-d20e50636604","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-DEVICE-ID","value":"simplai"},{"key":"PIM-SID","value":""},{"key":"X-TENANT-ID","value":""},{"key":"X-USER-ID","value":""}],"body":{"mode":"raw","raw":"{ \"tool_id\":\"\",\n \"language_code\": \"EN\",\n \"source\": \"APP\",\n \"action\": \"START_SCREEN\",\n \"cust_attr\": {\n },\n \"inputs\": {\n \"text\": \"HAPPY\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://edge-service.simplai.ai/interact/api/ve1/intract/tool/conversation","description":"

This endpoint makes an HTTP POST request to interact with the conversation API. The request should include a payload with the following parameters in the raw request body:

language_code (string): The language code for the conversation.
\n
source (string): The source of the conversation.
\n
tool_id (string): The ID of the tool.
\n
action (string): The action to be performed.
\n
inputs (object): An object containing the input key value pairs.
\n

The response to the request will have a status code of 200 and a content type of application/json. The response body will contain the following fields:

result (object): An object containing the following parameters:
\n
- conversation_id (string): The ID of the conversation.
  \n
- message_id (string): The ID of the message.
  \n
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PIM-SID"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c7951116-439a-4044-a661-ee1e16910c1a","id":"c7951116-439a-4044-a661-ee1e16910c1a","name":"SimplAI API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["interact","api","ve1","intract","tool","conversation"],"host":["edge-service","simplai","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"ccb4a527-755d-4814-9d0d-d20e50636604"},{"name":"Get Tool Run Result","id":"effde271-b5f3-4d4c-bed2-bd2b662980ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-USER-ID","value":""},{"key":"X-TENANT-ID","value":""},{"key":"PIM-SID","value":""},{"key":"X-DEVICE-ID","value":"simplai"}],"url":"https://edge-service.simplai.ai/interact/api/v1/intract/conversation/fetchDetails?cId=&mId=","description":"

Fetch Tool Result

This endpoint retrieves the result of a tool run using the provided conversation ID and message ID.

Request

Method: GET
\n
URL: https://edge-service.simplai.ai/interact/api/v1/intract/conversation/fetchDetails?cId=&mId=
\n

The Tool APIs allow you to access tools on the SimplAI platform programmatically.

\n","_postman_id":"d1cd4a8b-54c3-4750-abff-213e0059dcbb","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PIM-SID"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c7951116-439a-4044-a661-ee1e16910c1a","id":"c7951116-439a-4044-a661-ee1e16910c1a","name":"SimplAI API Documentation","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PIM-SID"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"63d5be29-dc39-4fee-a573-49a992c29542"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"313e1082-cc7a-40ab-b04c-c175d5865fea"}}],"variable":[{"key":"PIM-SID","value":"","type":"string"},{"key":"Tenant-ID","value":""},{"key":"User-ID","value":""},{"key":"cID","value":""},{"key":"mID","value":""}]}