KODA.AI API (1.2.3)

Download OpenAPI specification:Download

Authentication

OAuth

Security Scheme Type	OAuth2
clientCredentials OAuth Flow	Token URL: https://api.eu-pl.koda.ai/oauth/token Scopes: `inbox:read` - get available conversations `inbox:modify` - enable/disable moderator mode and send block/attachment/reply `knowledge_base:read` - search and retrieve knowledge base documents `knowledge_base:modify` - create, update, and delete knowledge base documents

Inbox API

List of chats

Returns a list of chats

Authorizations:

OAuth (inbox:read)

path Parameters

botId

required

string <uuid>

Example: 3337eb37-9c70-4e88-a173-21372501d7ee

query Parameters

page	number Default: 1 Example: page=3
on_page	number Default: 20 Example: on_page=3

header Parameters

Authorization

required

string <bearer>

Example: Bearer <Access Token>

Responses

Response samples

200
429

Content type

application/json

{"meta": {"status": 200,
"page": 0,
"per_page": 0,
"pages": 0,
"prev_url": "string",
"next_url": "string",
"found": 0,
"is_last_page": true
},
"response": [{"platform_user_id": "string",
"platform": "fb",
"avatar": "string",
"first_name": "string",
"last_name": "string",
"moderator_mode": true,
"last_inbox_message": {"date": 1578440306,
"text": "How can I help you",
"source": "moderator"
}
}
]
}

Get single chat

Authorizations:

OAuth (inbox:read)

path Parameters

botId required	string <uuid> Example: 3337eb37-9c70-4e88-a173-21372501d7ee
platformUserId required	string

query Parameters

page	number Default: 1 Example: page=3
on_page	number Default: 20 Example: on_page=3
from	number <timestamp>
to	number <timestamp>

header Parameters

Authorization

required

string <bearer>

Example: Bearer <Access Token>

Responses

Response samples

200
429

Content type

application/json

{"meta": {"status": 200,
"page": 0,
"per_page": 0,
"pages": 0,
"prev_url": "string",
"next_url": "string",
"found": 0,
"is_last_page": true
},
"response": [{"block_id": "3337eb37-9c70-4e88-a173-21372501d7ee",
"type": "moderator",
"date": 1578440306,
"block": {"type": "message",
"text": "string",
"buttons": [{"type": "go_to",
"go_to_block": "3337eb37-9c70-4e88-a173-21372501d7ee"
}
],
"quick_replies": [{"title": "Reply",
"go_to_block": "3337eb37-9c70-4e88-a173-21372501d7ee"
}
],
"serialize": "string"
}
}
]
}

Enable moderator mode

Authorizations:

OAuth (inbox:readinbox:modify)

path Parameters

botId required	string <uuid> Example: 3337eb37-9c70-4e88-a173-21372501d7ee
platformUserId required	string

Responses

Response samples

200
400
429

Content type

application/json

{"meta": {"status": 200
},
"response": true
}

Sent moderator message

Authorizations:

OAuth (inbox:readinbox:modify)

path Parameters

botId required	string <uuid> Example: 3337eb37-9c70-4e88-a173-21372501d7ee
platformUserId required	string

Request Body schema: application/json

moderator_message

required

string <= 1000 characters

Responses

Request samples

Payload

Content type

application/json

{"moderator_message": "string"
}

Response samples

200
400
429

Content type

application/json

{"meta": {"status": 200
},
"response": true
}

Disable moderator mode (mark done)

Authorizations:

OAuth (inbox:readinbox:modify)

path Parameters

botId required	string <uuid> Example: 3337eb37-9c70-4e88-a173-21372501d7ee
platformUserId required	string

Request Body schema: application/json

quiet	boolean Don`t send the block configured in the chatbot`s settings (dashboard)
message	string <= 1000 characters Overwrite message set in the dashboard. A Message will be sent to the user

Responses

Request samples

Payload

Content type

application/json

{"quiet": false,
"message": "From now on, you talk to the chatbot"
}

Response samples

200
400
429

Content type

application/json

{"meta": {"status": 200
},
"response": true
}

Send file attachment

Authorizations:

OAuth (inbox:readinbox:modify)

path Parameters

botId required	string <uuid> Example: 3337eb37-9c70-4e88-a173-21372501d7ee
platformUserId required	string

Request Body schema: multipart/form-data

audio	string <binary>
image	string <binary>
file	string <binary>
video	string <binary>

Responses

Response samples

200
400
429

Content type

application/json

{"meta": {"status": 200
},
"response": true
}

Send block

Send a content block as a bot response to a user, with optionally update user variables

Authorizations:

OAuth (inbox:readinbox:modify)

path Parameters

botId required	string <uuid> Example: 3337eb37-9c70-4e88-a173-21372501d7ee
platformUserId required	string

Request Body schema: application/json

block_id required	string Block id
	object Optional user variables

Responses

Request samples

Payload

Content type

application/json

{"block_id": "f60ea240-4cda-d1f9-032f-05eba5794058",
"user_variables": {"user_variable1": "value1",
"user_variable2": "value2"
}
}

Response samples

201
400
404
429

Content type

application/json

{ }

Knowledge Base API

API to manage knowledge base documents for generative AI capabilities.

Search knowledge base documents

Search for relevant documents in the knowledge base

Authorizations:

OAuth (knowledge_base:read)

path Parameters

botId

required

string <uuid>

Example: 3337eb37-9c70-4e88-a173-21372501d7ee

header Parameters

Authorization

required

string <bearer>

Example: Bearer <Access Token>

Request Body schema: application/json

search	string Search query text
	object

Responses

Request samples

Payload

Content type

application/json

{"search": "password reset",
"metadata_filter": {"relation_type": "AND",
"conditions": [{"meta_key": "category",
"operator": "in",
"values": ["faq"
]
}
]
}
}

Response samples

200
429

Content type

application/json

{"meta": {"page": 0,
"per_page": 0,
"pages": 0,
"prev_url": "string",
"next_url": "string",
"found": 0,
"is_last_page": true
},
"response": [{"doc_id": "3337eb37-9c70-4e88-a173-21372501d7ee",
"title": "Product Documentation",
"meta": {"category": "faq",
"department": "support"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create knowledge base document

Create a new document in the knowledge base

Authorizations:

OAuth (knowledge_base:modify)

path Parameters

botId

required

string <uuid>

Example: 3337eb37-9c70-4e88-a173-21372501d7ee

header Parameters

Authorization

required

string <bearer>

Example: Bearer <Access Token>

Request Body schema: application/json

title required	string <= 120 characters
content required	string
	object
auto_publish	boolean Default: false Automatically publish new version with changes. Otherwise, it will added to draft and user new approve changes in the dashboard.
chunk_size	integer [ 100 .. 1000 ] Chunk size for splitting the document into smaller parts. This is useful for large documents to improve searchability.

Responses

Request samples

Payload

Content type

application/json

{"title": "Product Documentation",
"content": "This is the content of the knowledge base document.",
"metadata": {"category": "faq",
"department": "support"
},
"auto_publish": true,
"chunk_size": 500
}

Response samples

201
429

Content type

application/json

{"doc_id": "3337eb37-9c70-4e88-a173-21372501d7ee",
"title": "Product Documentation",
"content": "This is the content of the knowledge base document.",
"meta": {"category": "faq",
"department": "support"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get knowledge base document

Retrieve a specific document from the knowledge base

Authorizations:

OAuth (knowledge_base:read)

path Parameters

botId required	string <uuid> Example: 3337eb37-9c70-4e88-a173-21372501d7ee
doc_id required	string <uuid> Example: 3337eb37-9c70-4e88-a173-21372501d7ee

header Parameters

Authorization

required

string <bearer>

Example: Bearer <Access Token>

Responses

Response samples

200
429

Content type

application/json

{"meta": {"status": 200
},
"response": {"doc_id": "3337eb37-9c70-4e88-a173-21372501d7ee",
"title": "Product Documentation",
"content": "This is the content of the knowledge base document.",
"meta": {"category": "faq",
"department": "support"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update knowledge base document

Update an existing document in the knowledge base

Authorizations:

OAuth (knowledge_base:modify)

path Parameters

botId required	string <uuid> Example: 3337eb37-9c70-4e88-a173-21372501d7ee
doc_id required	string <uuid> Example: 3337eb37-9c70-4e88-a173-21372501d7ee

header Parameters

Authorization

required

string <bearer>

Example: Bearer <Access Token>

Request Body schema: application/json

title required	string <= 120 characters
content required	string
	object
auto_publish	boolean Default: false Automatically publish new version with changes. Otherwise, it will added to draft and user new approve changes in the dashboard.
chunk_size	integer [ 100 .. 1000 ] Chunk size for splitting the document into smaller parts. This is useful for large documents to improve searchability.

Responses

Request samples

Payload

Content type

application/json

{"title": "Product Documentation",
"content": "This is the content of the knowledge base document.",
"metadata": {"category": "faq",
"department": "support"
},
"auto_publish": true,
"chunk_size": 500
}

Response samples

200
429

Content type

application/json

{"meta": {"status": 200
},
"response": {"success": true,
"doc": {"doc_id": "3337eb37-9c70-4e88-a173-21372501d7ee",
"title": "Product Documentation",
"content": "This is the content of the knowledge base document.",
"meta": {"category": "faq",
"department": "support"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}
}

Delete knowledge base document

Remove a document from the knowledge base

Authorizations:

OAuth (knowledge_base:modify)

path Parameters

botId required	string <uuid> Example: 3337eb37-9c70-4e88-a173-21372501d7ee
doc_id required	string <uuid> Example: 3337eb37-9c70-4e88-a173-21372501d7ee

header Parameters

Authorization

required

string <bearer>

Example: Bearer <Access Token>

Responses

Response samples

200
429

Content type

application/json

{"meta": {"status": 200
},
"response": {"success": true
}
}