Conversations

Download schema

Workspace conversations owned by the API key creator.

List workspace conversations

GET

https://saas.ha.knwl.me

/api/v1/conversations

Bearer (Developer API key)

Lists active conversations owned by the user that created the API key, across model-mode and agent-mode threads.

List workspace conversations › query Parameters

limit

integer · min: 1 · max: 100

Maximum conversations to return, between 1 and 100.

Default: 20

List workspace conversations › Responses

Conversation list.

ConversationListResponse

ok

const · required

Const value:

ConversationSummary[] · required

Create a model-mode or agent-mode conversation

POST

https://saas.ha.knwl.me

/api/v1/conversations

Bearer (Developer API key)

Creates an empty conversation. Idempotency-Key is mandatory; when conversationId is omitted, the server derives a deterministic conversation id from that key.

Create a model-mode or agent-mode conversation › Request Body

CreateConversationRequest

conversationId

string · uuid

agentId

string | null · uuid

projectId

string | null · uuid

accessMode

enum

Enum values:

private

workspace

restricted

Default: private

Create a model-mode or agent-mode conversation › Responses

Conversation created or idempotently replayed.

ConversationResponse

ok

const · required

Const value:

ConversationSummary · required

POST/api/v1/conversations

curl --request POST \
  --url https://saas.ha.knwl.me/api/v1/conversations \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversationId": "00000000-0000-0000-0000-000000000000",
  "agentId": "00000000-0000-0000-0000-000000000000",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "accessMode": "private"
}
'

Example Request Body

{
  "conversationId": "00000000-0000-0000-0000-000000000000",
  "agentId": "00000000-0000-0000-0000-000000000000",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "accessMode": "private"
}

json

Example Responses

{
  "ok": true,
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "agentId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "title": "title",
    "accessMode": "private",
    "includeTransverseKnowledge": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "archivedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Projects

List workspace conversations

GET

https://saas.ha.knwl.me

/api/v1/conversations

Bearer (Developer API key)

Lists active conversations owned by the user that created the API key, across model-mode and agent-mode threads.

List workspace conversations › query Parameters

limit

integer · min: 1 · max: 100

Maximum conversations to return, between 1 and 100.

Default: 20

List workspace conversations › Responses

Conversation list.

ConversationListResponse

ok

const · required

Const value:

ConversationSummary[] · required

Create a model-mode or agent-mode conversation

POST

https://saas.ha.knwl.me

/api/v1/conversations

Bearer (Developer API key)

Creates an empty conversation. Idempotency-Key is mandatory; when conversationId is omitted, the server derives a deterministic conversation id from that key.

Create a model-mode or agent-mode conversation › Request Body

CreateConversationRequest

conversationId

string · uuid

agentId

string | null · uuid

projectId

string | null · uuid

accessMode

enum

Enum values:

private

workspace

restricted

Default: private

Create a model-mode or agent-mode conversation › Responses

Conversation created or idempotently replayed.

ConversationResponse

ok

const · required

Const value:

ConversationSummary · required