FirstReply
API docs by Redocly

FirstReply API (1.0)

Download OpenAPI specification:Download

Support: support@firstreply.ai URL: https://firstreply.ai License: Apache 2.0

Please email support@firstreply.ai if you have questions or need help while using the API.

Pagination

When you're making calls to the API, there'll be a lot of results to return. For that reason, we paginate the results to make sure responses are easier to handle. We recommend you to set the limit parameter in every request to ensure you know how many results per page you'll get. The default limit is 100 items per page. You can paginate through the results with the page parameter, starting with 1. If you set the limit to 10 and page to 1 you will get the results from 1-10. If you set the limit to 10 and page to 2, you'll get the results from 11-20.

Webhook

Endpoint to retrieve and manage webhooks.

List webhooks

List webhooks.

path Parameters
organizationId
required
string
query Parameters
sort
string
order
string
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Create webhook

Create a new webhook.

path Parameters
organizationId
required
string
Request Body schema:
target
string
event
string

Responses

Request samples

Content type
{
  • "target": "string",
  • "event": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "organizationId": "string",
  • "target": "string",
  • "event": "string",
  • "lastUpdate": 0,
  • "created": 0
}

Get webhook

Get webhook by id.

path Parameters
organizationId
required
string
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "organizationId": "string",
  • "target": "string",
  • "event": "string",
  • "lastUpdate": 0,
  • "created": 0
}

Update webhook

Update webhook by id.

path Parameters
organizationId
required
string
id
required
string
Request Body schema:
target
string
event
string

Responses

Request samples

Content type
{
  • "target": "string",
  • "event": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "organizationId": "string",
  • "target": "string",
  • "event": "string",
  • "lastUpdate": 0,
  • "created": 0
}

Remove webhook

Remove webhook by id.

path Parameters
organizationId
required
string
id
required
string

Responses

Search webhooks

Search webhooks by given parameters.

path Parameters
organizationId
required
string
Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
event
string
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "event": "string",
  • "offset": 0
}

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Profile

Endpoint to retrieve and manage the current user.

Get profile

Retrieves the profile of the current user.

query Parameters
referrer
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "imageUrl": "string",
  • "ipAddress": "string",
  • "language": "string",
  • "referrer": "string",
  • "newsletter": true,
  • "displayName": "string",
  • "admin": true
}

Update profile

Updates the profile of the current user.

Request Body schema:
email
string
firstname
string
lastname
string
imageUrl
string
language
string
newsletter
boolean

Responses

Request samples

Content type
{
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "imageUrl": "string",
  • "language": "string",
  • "newsletter": true
}

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "imageUrl": "string",
  • "ipAddress": "string",
  • "language": "string",
  • "referrer": "string",
  • "newsletter": true,
  • "displayName": "string",
  • "admin": true
}

Organization

Endpoint to retrieve and manage organizations.

List organizations

List organizations.

query Parameters
sort
string
order
string
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Create organization

Create a new organization.

Request Body schema:
name
string
language
string
description
string
color
integer <int32>
contactStory
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "language": "string",
  • "description": "string",
  • "color": 0,
  • "contactStory": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "name": "string",
  • "language": "string",
  • "description": "string",
  • "color": 0,
  • "apiKey": "string",
  • "contactStory": "string",
  • "numInboxes": 0,
  • "numMembers": 0,
  • "plan": "string",
  • "maxInboxes": 0,
  • "maxMembers": 0,
  • "expires": 0,
  • "permission": 0,
  • "active": true,
  • "cancelled": true,
  • "expired": true,
  • "managerOrAdmin": true,
  • "member": true,
  • "manager": true,
  • "admin": true,
  • "owner": true,
  • "trial": true
}

Get organization

Get organization by id.

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "name": "string",
  • "language": "string",
  • "description": "string",
  • "color": 0,
  • "apiKey": "string",
  • "contactStory": "string",
  • "numInboxes": 0,
  • "numMembers": 0,
  • "plan": "string",
  • "maxInboxes": 0,
  • "maxMembers": 0,
  • "expires": 0,
  • "permission": 0,
  • "active": true,
  • "cancelled": true,
  • "expired": true,
  • "managerOrAdmin": true,
  • "member": true,
  • "manager": true,
  • "admin": true,
  • "owner": true,
  • "trial": true
}

Update organization

Update organization by id.

path Parameters
id
required
string
Request Body schema:
name
string
language
string
description
string
color
integer <int32>
contactStory
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "language": "string",
  • "description": "string",
  • "color": 0,
  • "contactStory": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "name": "string",
  • "language": "string",
  • "description": "string",
  • "color": 0,
  • "apiKey": "string",
  • "contactStory": "string",
  • "numInboxes": 0,
  • "numMembers": 0,
  • "plan": "string",
  • "maxInboxes": 0,
  • "maxMembers": 0,
  • "expires": 0,
  • "permission": 0,
  • "active": true,
  • "cancelled": true,
  • "expired": true,
  • "managerOrAdmin": true,
  • "member": true,
  • "manager": true,
  • "admin": true,
  • "owner": true,
  • "trial": true
}

Regenerate API Key

Regenerate API Key.

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "name": "string",
  • "language": "string",
  • "description": "string",
  • "color": 0,
  • "apiKey": "string",
  • "contactStory": "string",
  • "numInboxes": 0,
  • "numMembers": 0,
  • "plan": "string",
  • "maxInboxes": 0,
  • "maxMembers": 0,
  • "expires": 0,
  • "permission": 0,
  • "active": true,
  • "cancelled": true,
  • "expired": true,
  • "managerOrAdmin": true,
  • "member": true,
  • "manager": true,
  • "admin": true,
  • "owner": true,
  • "trial": true
}

Search organizations

Search organizations by given parameters.

Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "offset": 0
}

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Contact

Endpoint to retrieve and manage contacts.

List contacts

List contacts.

path Parameters
organizationId
required
string
query Parameters
sort
string
order
string
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Create contact

Create a new contact.

path Parameters
organizationId
required
string
Request Body schema:
firstname
string
lastname
string
name
string
email
string
phone
string
imageUrl
string
description
string
Array of objects (ContactFieldValueUpdateDto)
valid
boolean

Responses

Request samples

Content type
{
  • "firstname": "string",
  • "lastname": "string",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "imageUrl": "string",
  • "description": "string",
  • "fields": [
    ],
  • "valid": true
}

Response samples

Content type
{
  • "id": "string",
  • "organizationId": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "imageUrl": "string",
  • "description": "string",
  • "fields": [
    ],
  • "displayName": "string",
  • "initials": "string"
}

Get contact

Get contact by id.

path Parameters
organizationId
required
string
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "organizationId": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "imageUrl": "string",
  • "description": "string",
  • "fields": [
    ],
  • "displayName": "string",
  • "initials": "string"
}

Update contact

Update contact by id.

path Parameters
organizationId
required
string
id
required
string
Request Body schema:
firstname
string
lastname
string
name
string
email
string
phone
string
imageUrl
string
description
string
Array of objects (ContactFieldValueUpdateDto)

Responses

Request samples

Content type
{
  • "firstname": "string",
  • "lastname": "string",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "imageUrl": "string",
  • "description": "string",
  • "fields": [
    ]
}

Response samples

Content type
{
  • "id": "string",
  • "organizationId": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "imageUrl": "string",
  • "description": "string",
  • "fields": [
    ],
  • "displayName": "string",
  • "initials": "string"
}

Remove contact

Remove contact by id.

path Parameters
organizationId
required
string
id
required
string

Responses

Search contacts

Search contacts by given parameters.

path Parameters
organizationId
required
string
Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
senderOnly
boolean
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "senderOnly": true,
  • "offset": 0
}

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Message

Endpoint to retrieve and manage messages.

Get message

Get message by id.

path Parameters
organizationId
required
string
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "organizationId": "string",
  • "inboxId": "string",
  • "conversationId": "string",
  • "attachments": [
    ],
  • "subject": "string",
  • "messagePlain": "string",
  • "messageHtml": "string",
  • "translation": "string",
  • "outgoing": true,
  • "positive": true,
  • "opened": 0,
  • "sender": {
    },
  • "to": [
    ],
  • "cc": [
    ],
  • "bcc": [
    ],
  • "messageId": "string",
  • "inReplyTo": "string",
  • "messageReferences": "string"
}

Update message

Update message by id.

path Parameters
organizationId
required
string
id
required
string
Request Body schema:
subject
string
messagePlain
string
messageHtml
string
outgoing
boolean
positive
boolean
opened
integer <int32>
object (MessageContactDto)
Array of objects (MessageContactDto)
Array of objects (MessageContactDto)
Array of objects (MessageContactDto)
messageId
string
inReplyTo
string
messageReferences
string

Responses

Request samples

Content type
{
  • "subject": "string",
  • "messagePlain": "string",
  • "messageHtml": "string",
  • "outgoing": true,
  • "positive": true,
  • "opened": 0,
  • "sender": {
    },
  • "to": [
    ],
  • "cc": [
    ],
  • "bcc": [
    ],
  • "messageId": "string",
  • "inReplyTo": "string",
  • "messageReferences": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "organizationId": "string",
  • "inboxId": "string",
  • "conversationId": "string",
  • "attachments": [
    ],
  • "subject": "string",
  • "messagePlain": "string",
  • "messageHtml": "string",
  • "translation": "string",
  • "outgoing": true,
  • "positive": true,
  • "opened": 0,
  • "sender": {
    },
  • "to": [
    ],
  • "cc": [
    ],
  • "bcc": [
    ],
  • "messageId": "string",
  • "inReplyTo": "string",
  • "messageReferences": "string"
}

Remove message

Remove message by id.

path Parameters
organizationId
required
string
id
required
string

Responses

Opened message

Opened message by id.

path Parameters
organizationId
required
string
id
required
string

Responses

Reply message

Reply to a message.

path Parameters
organizationId
required
string
id
required
string
Request Body schema:
subject
string
messagePlain
string
messageHtml
string
language
string
translation
string
outgoing
boolean
positive
boolean
opened
integer <int32>
object (MessageContactDto)
Array of objects (MessageContactDto)
Array of objects (MessageContactDto)
Array of objects (MessageContactDto)
Array of objects (MessageAttachmentDto)
messageId
string
inReplyTo
string
messageReferences
string
created
integer <int64>
valid
boolean

Responses

Request samples

Content type
{
  • "subject": "string",
  • "messagePlain": "string",
  • "messageHtml": "string",
  • "language": "string",
  • "translation": "string",
  • "outgoing": true,
  • "positive": true,
  • "opened": 0,
  • "sender": {
    },
  • "to": [
    ],
  • "cc": [
    ],
  • "bcc": [
    ],
  • "attachments": [
    ],
  • "messageId": "string",
  • "inReplyTo": "string",
  • "messageReferences": "string",
  • "created": 0,
  • "valid": true
}

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "organizationId": "string",
  • "inboxId": "string",
  • "conversationId": "string",
  • "attachments": [
    ],
  • "subject": "string",
  • "messagePlain": "string",
  • "messageHtml": "string",
  • "translation": "string",
  • "outgoing": true,
  • "positive": true,
  • "opened": 0,
  • "sender": {
    },
  • "to": [
    ],
  • "cc": [
    ],
  • "bcc": [
    ],
  • "messageId": "string",
  • "inReplyTo": "string",
  • "messageReferences": "string"
}

Search messages

Search messages by given parameters.

path Parameters
organizationId
required
string
Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
conversationId
string
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "conversationId": "string",
  • "offset": 0
}

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Classification

Endpoint to retrieve and manage classifications.

List classifications

List classifications.

path Parameters
organizationId
required
string
query Parameters
sort
string
order
string
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Create classification

Create a new classification.

path Parameters
organizationId
required
string
Request Body schema:
name
string
color
integer <int32>
aiReply
boolean
sentimentAnalysis
boolean
autoClose
boolean
defaultMemberId
string
promptId
string
templateId
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "color": 0,
  • "aiReply": true,
  • "sentimentAnalysis": true,
  • "autoClose": true,
  • "defaultMemberId": "string",
  • "promptId": "string",
  • "templateId": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "organizationId": "string",
  • "name": "string",
  • "color": 0,
  • "aiReply": true,
  • "sentimentAnalysis": true,
  • "autoClose": true,
  • "defaultMemberId": "string",
  • "defaultMember": {
    },
  • "promptId": "string",
  • "prompt": {
    },
  • "templateId": "string",
  • "template": {
    }
}

Get classification

Get classification by id.

path Parameters
organizationId
required
string
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "organizationId": "string",
  • "name": "string",
  • "color": 0,
  • "aiReply": true,
  • "sentimentAnalysis": true,
  • "autoClose": true,
  • "defaultMemberId": "string",
  • "defaultMember": {
    },
  • "promptId": "string",
  • "prompt": {
    },
  • "templateId": "string",
  • "template": {
    }
}

Update classification

Update classification by id.

path Parameters
organizationId
required
string
id
required
string
Request Body schema:
name
string
color
integer <int32>
aiReply
boolean
sentimentAnalysis
boolean
autoClose
boolean
defaultMemberId
string
templateId
string
promptId
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "color": 0,
  • "aiReply": true,
  • "sentimentAnalysis": true,
  • "autoClose": true,
  • "defaultMemberId": "string",
  • "templateId": "string",
  • "promptId": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "organizationId": "string",
  • "name": "string",
  • "color": 0,
  • "aiReply": true,
  • "sentimentAnalysis": true,
  • "autoClose": true,
  • "defaultMemberId": "string",
  • "defaultMember": {
    },
  • "promptId": "string",
  • "prompt": {
    },
  • "templateId": "string",
  • "template": {
    }
}

Remove classification

Remove classification by id.

path Parameters
organizationId
required
string
id
required
string

Responses

Search classifications

Search classifications by given parameters.

path Parameters
organizationId
required
string
Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "offset": 0
}

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Prompt

Endpoint to retrieve and manage prompts.

List prompts

List prompts.

path Parameters
organizationId
required
string
query Parameters
sort
string
order
string
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Create prompt

Create a new prompt.

path Parameters
organizationId
required
string
Request Body schema:
name
string
text
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "text": "string"
}

Response samples

Content type
{
  • "organizationId": "string",
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "name": "string",
  • "text": "string"
}

Get prompt

Get prompt by id.

path Parameters
organizationId
required
string
id
required
string

Responses

Response samples

Content type
{
  • "organizationId": "string",
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "name": "string",
  • "text": "string"
}

Update prompt

Update prompt by id.

path Parameters
organizationId
required
string
id
required
string
Request Body schema:
name
string
text
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "text": "string"
}

Response samples

Content type
{
  • "organizationId": "string",
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "name": "string",
  • "text": "string"
}

Remove prompt

Remove prompt by id.

path Parameters
organizationId
required
string
id
required
string

Responses

Search prompts

Search prompts by given parameters.

path Parameters
organizationId
required
string
Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "offset": 0
}

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Template

Endpoint to retrieve and manage templates.

List templates

List templates.

path Parameters
organizationId
required
string
query Parameters
sort
string
order
string
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Create template

Create a new template.

path Parameters
organizationId
required
string
Request Body schema:
name
string
language
string
parentId
string
plain
string
html
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "language": "string",
  • "parentId": "string",
  • "plain": "string",
  • "html": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "organizationId": "string",
  • "name": "string",
  • "language": "string",
  • "parentId": "string",
  • "plain": "string",
  • "html": "string"
}

Get template

Get template by id.

path Parameters
organizationId
required
string
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "organizationId": "string",
  • "name": "string",
  • "language": "string",
  • "parentId": "string",
  • "plain": "string",
  • "html": "string"
}

Update template

Update template by id.

path Parameters
organizationId
required
string
id
required
string
Request Body schema:
name
string
language
string
parentId
string
plain
string
html
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "language": "string",
  • "parentId": "string",
  • "plain": "string",
  • "html": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "organizationId": "string",
  • "name": "string",
  • "language": "string",
  • "parentId": "string",
  • "plain": "string",
  • "html": "string"
}

Remove template

Remove template by id.

path Parameters
organizationId
required
string
id
required
string

Responses

Search templates

Search templates by given parameters.

path Parameters
organizationId
required
string
Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
hasParentId
boolean
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "hasParentId": true,
  • "offset": 0
}

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Knowledge

Endpoint to retrieve and manage knowledge entries.

List knowledge entries

List knowledge entries.

path Parameters
organizationId
required
string
query Parameters
sort
string
order
string
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Create knowledge entry

Create a new knowledge entry.

path Parameters
organizationId
required
string
Request Body schema:
classificationId
string
positive
boolean
prompt
string
completion
string

Responses

Request samples

Content type
{
  • "classificationId": "string",
  • "positive": true,
  • "prompt": "string",
  • "completion": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "organizationId": "string",
  • "classificationId": "string",
  • "positive": true,
  • "prompt": "string",
  • "completion": "string",
  • "classification": {
    }
}

Get knowledge entry

Get knowledge entry by id.

path Parameters
organizationId
required
string
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "organizationId": "string",
  • "classificationId": "string",
  • "positive": true,
  • "prompt": "string",
  • "completion": "string",
  • "classification": {
    }
}

Update knowledge entry

Update knowledge entry by id.

path Parameters
organizationId
required
string
id
required
string
Request Body schema:
classificationId
string
positive
boolean
prompt
string
completion
string

Responses

Request samples

Content type
{
  • "classificationId": "string",
  • "positive": true,
  • "prompt": "string",
  • "completion": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "organizationId": "string",
  • "classificationId": "string",
  • "positive": true,
  • "prompt": "string",
  • "completion": "string",
  • "classification": {
    }
}

Remove knowledge entry

Remove knowledge entry by id.

path Parameters
organizationId
required
string
id
required
string

Responses

Search knowledge entries

Search knowledge entries by given parameters.

path Parameters
organizationId
required
string
Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
classificationIds
Array of strings
created
integer <int64>
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "classificationIds": [
    ],
  • "created": 0,
  • "offset": 0
}

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}