Conversations

Get conversations for the logged-in user

get

https://api-dev.jsmon.shhttps://api.jsmon.sh

/conversations

Authorizations

bearerAuth

Query parameters

wkspIdstringRequired

Workspace ID to filter conversations

Responses

200

Conversations retrieved successfully

application/json

401

Unauthorized - Missing or invalid token

500

Internal Server Error

application/json

get

/conversations

HTTPcURLJavaScriptPython

GET /conversations?wkspId=text HTTP/1.1
Host: api-dev.jsmon.sh
Accept: */*

{
  "message": "Conversation retrieved successfully",
  "data": [
    {
      "conversationId": "abc123",
      "conversationName": "Team Discussion",
      "createdAt": "2024-09-01T14:20:00.000Z",
      "lastUpdated": "text"
    }
  ]
}

Get Q&A data for a specific conversation by ID

get

https://api-dev.jsmon.shhttps://api.jsmon.sh

/conversations/{conversationId}

Authorizations

bearerAuth

Path parameters

conversationIdstringRequired

ID of the conversation to retrieve

Query parameters

wkspIdstringRequired

Workspace ID to filter data

Responses

200

Conversation retrieved successfully

application/json

400

Missing conversation ID

application/json

401

Unauthorized

500

Internal Server Error

get

/conversations/{conversationId}

HTTPcURLJavaScriptPython

GET /conversations/{conversationId}?wkspId=text HTTP/1.1
Host: api-dev.jsmon.sh
Accept: */*

{
  "message": "Conversation retrieved successfully",
  "data": [
    {
      "question": "What is your name?",
      "answer": "My name is ChatGPT.",
      "createdAt": "2024-09-01T14:20:00.000Z",
      "lastUpdated": "2024-09-03T18:45:00.000Z"
    }
  ]
}

Delete a conversation and its related Q&A by conversationId

delete

https://api-dev.jsmon.shhttps://api.jsmon.sh

/conversations/{conversationId}

Authorizations

bearerAuth

Path parameters

conversationIdstringRequired

The ID of the conversation to delete

Query parameters

wkspIdstringRequired

Workspace ID associated with the conversation

Responses

200

Conversation deleted successfully

application/json

400

Missing conversation ID

application/json

401

Unauthorized - JWT token missing or invalid

500

Internal Server Error

application/json

delete

/conversations/{conversationId}

HTTPcURLJavaScriptPython

DELETE /conversations/{conversationId}?wkspId=text HTTP/1.1
Host: api-dev.jsmon.sh
Accept: */*

{
  "message": "Conversation deleted successfully"
}

Edit the name of a conversation by conversationId

patch

https://api-dev.jsmon.shhttps://api.jsmon.sh

/conversations/edit-name

Authorizations

bearerAuth

Query parameters

wkspIdstringRequired

Workspace ID

Body

application/json

conversationIdstringRequiredExample: abc123

updatedNamestringRequiredExample: New Conversation Name

Responses

200

Name updated or already same

application/json

400

Missing required fields

application/json

404

Conversation not found

application/json

500

Internal Server Error

application/json

patch

/conversations/edit-name

HTTPcURLJavaScriptPython

PATCH /conversations/edit-name?wkspId=text HTTP/1.1
Host: api-dev.jsmon.sh
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "conversationId": "abc123",
  "updatedName": "New Conversation Name"
}

{
  "message": "Conversation name updated successfully"
}