API

دانش

هر عملیات در این گروه: آنچه می‌پذیرد، آنچه برمی‌گرداند و خطاهایی که ممکن است با آن‌ها پاسخ دهد.

عملیات‌ها

The workspace knowledge base: notes, files and web pages the AI uses when it writes replies, drafts email and answers in the assistant. Each item sits at one level. A scope is empty for the whole workspace, @ and a domain for everything on that domain (@acme.com), or one address ([email protected]). The AI working for an address reads that address, then its domain, then the whole workspace, the most specific first.

Files are read into text in the background, PDFs, Office and OpenDocument files, spreadsheets, CSV, HTML, XML, Markdown, text and images among them. Text is encrypted at rest, and search runs over the meaning of the text as well as its words.

GET`/knowledge`

List knowledge items

knowledge:readمی‌خواند

Newest first. Every filter is optional. q matches titles, file names and links. A key or an app limited to particular addresses sees the whole-workspace items and the items at its addresses and their domains.

Requires the knowledge:read scope.

پارامترهای کوئری

scopestring: Only the items at exactly this level. A scope is empty for the whole workspace, @ and a domain for everything on that domain (@acme.com), or one address ([email protected]). The AI working for an address reads that address, then its domain, then the whole workspace, the most specific first.
levelstring: Only items at this kind of level.
یکی از"workspace""domain""address"
kindstring: Keeps one kind of item: note, file or link.
یکی از"note""file""link"
statusstring: Keeps one status: queued, processing, ready or failed.
یکی از"queued""processing""ready""failed"
pinnedstring: true keeps the pinned notes and false everything else.
یکی از"true""false"
qstring: Words in the title, file name or link.
limitinteger: Rows per page, 1 to 100.
دست‌کم 1حداکثر 100پیش‌فرض25
cursorstring: The previous page's nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400 invalid_cursor.

خروجی

200KnowledgeItemList

A page of items.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.list()knowledge.listAll()knowledge.iterate()
Python: knowledge.list()knowledge.list_all()knowledge.iterate()
Ruby: knowledge.listknowledge.list_allknowledge.iterate
PHP: knowledge->listknowledge->listAllknowledge->iterate
CLI: openemail knowledge list
MCP: listKnowledge

GET`/knowledge/levels`

List knowledge levels

knowledge:readمی‌خواند

The whole workspace, each domain and each address the caller can see, how many items each holds and whether the caller may change items there.

Requires the knowledge:read scope.

خروجی

200KnowledgeLevelList

Every level the caller can see.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.levels()
Python: knowledge.levels()
Ruby: knowledge.levels
PHP: knowledge->levels
CLI: openemail knowledge levels
MCP: listKnowledgeLevels

GET`/knowledge/usage`

Read knowledge base usage

knowledge:readمی‌خواند

How many items and characters of text the workspace holds, against what its plan allows.

Requires the knowledge:read scope.

خروجی

200KnowledgeUsage

The usage and the limits.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.usage()
Python: knowledge.usage()
Ruby: knowledge.usage
PHP: knowledge->usage
CLI: openemail knowledge usage
MCP: getKnowledgeUsage

POST`/knowledge/search`

Search the knowledge base

knowledge:readمی‌خواند

The passages that best answer query, by meaning and by words, the way the AI finds them. With address, the levels the AI uses for that address: the address, its domain and the whole workspace, the most specific ranked a little higher. With scope, that one level. With neither, every level the caller can see.

Requires the knowledge:read scope.

بدنهٔ درخواست

querystringالزامی: What to look for, in plain words, up to 500 characters.
1 تا 500 نویسه
addressstring: An address of the workspace, to search the levels the AI uses when it writes as that address.
تا 320 نویسه
scopestring: One level to search: an empty string for the whole workspace, @ and a domain, or one address.
تا 320 نویسه
limitinteger: How many passages, from 1 to 25. The server defaults to 8.
دست‌کم 1حداکثر 25
rerankboolean: When true, the AI reads the best 25 passages and puts them in the order that best answers query, leaving out the ones that do not help. It adds a second or two and counts as one AI action. When it cannot finish, the passages keep their usual order and reranked is false.

خروجی

200KnowledgeSearchResult

The passages, best first.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.search()
Python: knowledge.search()
Ruby: knowledge.search
PHP: knowledge->search
CLI: openemail knowledge search
MCP: searchKnowledge

POST`/knowledge/notes`

Add a note

knowledge:writeداده‌ها را تغییر می‌دهد

Up to 20,000 characters of text, in Markdown if you like. A note is usually ready for the AI in a second or two. Changing an item needs reach over every address its level covers: the whole workspace needs every address, a domain needs the whole domain, and an address needs that address. A key or an app limited to particular addresses can change items only at those addresses, or at domains it holds whole.

Requires the knowledge:write scope.

بدنهٔ درخواست

scopestring: The level: an empty string, or left out, for the whole workspace, @ and a domain such as @acme.com, or one address such as [email protected].
تا 320 نویسهپیش‌فرض""
titlestringالزامی: A short name for the note, at most 200 characters.
1 تا 200 نویسه
bodystringالزامی: The text, up to 20,000 characters, in Markdown if you like.
1 تا 20000 نویسه
pinnedboolean: Puts the note into every prompt at its level. Left out, false.
threadIdstring: The conversation the note comes from, such as one POST /knowledge/drafts drafted it from.
1 تا 200 نویسه

خروجی

201KnowledgeItem

The note.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.createNote()
Python: knowledge.create_note()
Ruby: knowledge.create_note
PHP: knowledge->createNote
CLI: openemail knowledge create-note
MCP: addKnowledgeNote

POST`/knowledge/links`

Add a link

knowledge:writeداده‌ها را تغییر می‌دهد

A public web page, at most 2048 characters long. It is fetched and read in the background, so the item starts queued. Without a title, the page's own title is used. Changing an item needs reach over every address its level covers: the whole workspace needs every address, a domain needs the whole domain, and an address needs that address. A key or an app limited to particular addresses can change items only at those addresses, or at domains it holds whole.

Requires the knowledge:write scope.

بدنهٔ درخواست

scopestring: The level: an empty string, or left out, for the whole workspace, @ and a domain such as @acme.com, or one address such as [email protected].
تا 320 نویسهپیش‌فرض""
urlstringالزامی: The page, a public http or https address of at most 2,048 characters.
1 تا 2048 نویسه
titlestring: A name for the item, at most 200 characters. Left out, the page's own title once it has been read.
تا 200 نویسه
refreshDaysinteger: Read the page again every this many days (1, 7, 30), so changes reach the AI on their own. Left out or null, it is read again only when you ask.
می‌تواند null باشدبیش از 0

خروجی

201KnowledgeItem

The link, queued to be read.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.addLink()
Python: knowledge.add_link()
Ruby: knowledge.add_link
PHP: knowledge->addLink
CLI: openemail knowledge add-link
MCP: addKnowledgeLink

POST`/knowledge/files`

Upload a file

knowledge:writeداده‌ها را تغییر می‌دهد

Send the file itself as the request body, with its Content-Type, and name it with filename or an X-Filename header. At most 20 MB for a document and 10 MB for an image. The text is read in the background, so the item starts queued. Changing an item needs reach over every address its level covers: the whole workspace needs every address, a domain needs the whole domain, and an address needs that address. A key or an app limited to particular addresses can change items only at those addresses, or at domains it holds whole.

Requires the knowledge:write scope.

پارامترهای کوئری

scopestring: A scope is empty for the whole workspace, @ and a domain for everything on that domain (@acme.com), or one address ([email protected]). The AI working for an address reads that address, then its domain, then the whole workspace, the most specific first.
filenamestring: The file name. Its extension tells the kind of file when the Content-Type is generic.
titlestring: Left out, the file name without its extension.
تا 200 نویسه

بدنهٔ درخواست

نوع محتواapplication/octet-stream

binary

خروجی

201KnowledgeItem

The file, queued to be read.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.uploadFile()
Python: knowledge.upload_file()
Ruby: knowledge.upload_file
PHP: knowledge->uploadFile
CLI: openemail knowledge upload-file

GET`/knowledge/{id}`

Get a knowledge item

knowledge:readمی‌خواند

The item with its text: a note's body, or the first 20,000 characters read from a file or a page.

Requires the knowledge:read scope.

پارامترهای مسیر

idstringالزامی: The id of a knowledge item, as GET /knowledge returns it.

خروجی

200KnowledgeItemDetail

The item and its text.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.get()
Python: knowledge.get()
Ruby: knowledge.get
PHP: knowledge->get
CLI: openemail knowledge get
MCP: getKnowledge

PATCH`/knowledge/{id}`

Change a knowledge item

knowledge:writeداده‌ها را تغییر می‌دهد

Give at least one field. body and pinned are for notes, url and refreshDays are for links. A changed title, body or link is indexed again, and an item moved to another level keeps its index. Changing an item needs reach over every address its level covers: the whole workspace needs every address, a domain needs the whole domain, and an address needs that address. A key or an app limited to particular addresses can change items only at those addresses, or at domains it holds whole. Moving an item needs that reach at both levels.

Requires the knowledge:write scope.

پارامترهای مسیر

idstringالزامی: The id of a knowledge item, as GET /knowledge returns it.

بدنهٔ درخواست

titlestring: A new name, at most 200 characters.
1 تا 200 نویسه
bodystring: Notes only.
1 تا 20000 نویسه
scopestring: A scope is empty for the whole workspace, @ and a domain for everything on that domain (@acme.com), or one address ([email protected]). The AI working for an address reads that address, then its domain, then the whole workspace, the most specific first.
pinnedboolean: Notes only.
urlstring: Links only.
1 تا 2048 نویسه
refreshDaysinteger: Links only: read the page again every this many days. Null stops that.
می‌تواند null باشدیکی از1730

خروجی

200KnowledgeItem

The item as it is now.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.update()
Python: knowledge.update()
Ruby: knowledge.update
PHP: knowledge->update
CLI: openemail knowledge update
MCP: updateKnowledge

DELETE`/knowledge/{id}`

Delete a knowledge item

knowledge:writeحذف می‌کند

Gone for good, with its file and its passages. The AI stops using it at once.

Requires the knowledge:write scope.

پارامترهای مسیر

idstringالزامی: The id of a knowledge item, as GET /knowledge returns it.

خروجی

200DeletedKnowledgeItem

Deleted.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.delete()
Python: knowledge.delete()
Ruby: knowledge.delete
PHP: knowledge->delete
CLI: openemail knowledge delete
MCP: deleteKnowledge

POST`/knowledge/{id}/refresh`

Read a knowledge item again

knowledge:writeداده‌ها را تغییر می‌دهد

Fetches a link again, reads a file again, or indexes a note again, and clears a failure. The previous text stays in use until the new one is ready.

Requires the knowledge:write scope.

پارامترهای مسیر

idstringالزامی: The id of a knowledge item, as GET /knowledge returns it.

خروجی

200KnowledgeItem

The item, queued to be read again.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.refresh()
Python: knowledge.refresh()
Ruby: knowledge.refresh
PHP: knowledge->refresh
CLI: openemail knowledge refresh
MCP: refreshKnowledge

GET`/knowledge/stats`

Read knowledge base stats

knowledge:readمی‌خواند

How the AI used the knowledge base over the last days days, 30 unless you say. uses counts the times a reply suggestion, a draft, the assistant or a search found something in it and empty the times it looked and found nothing, for the whole workspace, with bySurface splitting uses by where. topItems, unusedItems, the waiting suggestions and questions and the open flags count only what the caller can see.

Requires the knowledge:read scope.

پارامترهای کوئری

daysinteger: How many days back to count, today included.
دست‌کم 1حداکثر 90پیش‌فرض30

خروجی

200KnowledgeStats

The stats.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.stats()
Python: knowledge.stats()
Ruby: knowledge.stats
PHP: knowledge->stats
CLI: openemail knowledge stats
MCP: getKnowledgeStats

GET`/knowledge/suggestions`

List knowledge suggestions

knowledge:readمی‌خواند

Notes the AI suggests and questions nothing in the knowledge base answers, the most recent first, pending ones unless you ask for another status. A learned suggestion comes from a reply sent from the workspace in a conversation: the AI reads the message the reply answers and the reply, and keeps up to three facts that would hold for other people too, at the level of the domain the reply was sent from, or the whole workspace when that domain is not one of its own. Facts the knowledge base already holds are left out, and at most 100 replies a day are read. A question comes from an incoming message: when the AI suggests replies to it, it notes up to 3 things the sender asked about the business that neither the conversation nor the knowledge base answers, at the level of the domain the message arrived at, chosen the same way. The same fact or question again counts up occurrences, and one that was dismissed is not suggested again. Both stop while the workspace setting knowledgeLearning is off.

Requires the knowledge:read scope.

پارامترهای کوئری

kindstring: Keeps one kind: learned for notes drawn from sent replies, or question for questions nothing answers.
یکی از"learned""question"
statusstring: Keeps one status: pending, accepted or dismissed. Left out, pending.
یکی از"pending""accepted""dismissed"پیش‌فرض"pending"
limitinteger: Rows per page, 1 to 100.
دست‌کم 1حداکثر 100پیش‌فرض25
cursorstring: The previous page's nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400 invalid_cursor.

خروجی

200KnowledgeSuggestionList

A page of suggestions and questions.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.listSuggestions()knowledge.listAllSuggestions()knowledge.iterateSuggestions()
Python: knowledge.list_suggestions()knowledge.list_all_suggestions()knowledge.iterate_suggestions()
Ruby: knowledge.list_suggestionsknowledge.list_all_suggestionsknowledge.iterate_suggestions
PHP: knowledge->listSuggestionsknowledge->listAllSuggestionsknowledge->iterateSuggestions
CLI: openemail knowledge list-suggestions
MCP: listKnowledgeSuggestions

POST`/knowledge/suggestions/{id}/accept`

Accept a knowledge suggestion

knowledge:writeداده‌ها را تغییر می‌دهد

Saves the suggestion as a note, with any field you send in place of the suggested one, and marks it accepted. A question needs its answer in body, and its title stays the question unless you send one. Changing an item needs reach over every address its level covers: the whole workspace needs every address, a domain needs the whole domain, and an address needs that address. A key or an app limited to particular addresses can change items only at those addresses, or at domains it holds whole.

Requires the knowledge:write scope.

پارامترهای مسیر

idstringالزامی: The id of a suggestion or question, as GET /knowledge/suggestions returns it.

بدنهٔ درخواست

titlestring: Left out, the suggested title or the question.
1 تا 200 نویسه
bodystring: Left out, the suggested note. A question needs it: the answer.
1 تا 20000 نویسه
scopestring: Left out, the suggested level. A scope is empty for the whole workspace, @ and a domain for everything on that domain (@acme.com), or one address ([email protected]). The AI working for an address reads that address, then its domain, then the whole workspace, the most specific first.
pinnedboolean: Put the note into every prompt at its level.

خروجی

200KnowledgeSuggestionAccepted

The suggestion and the note made from it.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.acceptSuggestion()
Python: knowledge.accept_suggestion()
Ruby: knowledge.accept_suggestion
PHP: knowledge->acceptSuggestion
CLI: openemail knowledge accept-suggestion
MCP: acceptKnowledgeSuggestion

POST`/knowledge/suggestions/{id}/dismiss`

Dismiss a knowledge suggestion

knowledge:writeداده‌ها را تغییر می‌دهد

Marks the suggestion or question dismissed, so it leaves the pending list and is not suggested again. Nothing is added to the knowledge base. Changing an item needs reach over every address its level covers: the whole workspace needs every address, a domain needs the whole domain, and an address needs that address. A key or an app limited to particular addresses can change items only at those addresses, or at domains it holds whole.

Requires the knowledge:write scope.

پارامترهای مسیر

idstringالزامی: The id of a suggestion or question, as GET /knowledge/suggestions returns it.

خروجی

200KnowledgeSuggestion

The suggestion, dismissed.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.dismissSuggestion()
Python: knowledge.dismiss_suggestion()
Ruby: knowledge.dismiss_suggestion
PHP: knowledge->dismissSuggestion
CLI: openemail knowledge dismiss-suggestion
MCP: dismissKnowledgeSuggestion

GET`/knowledge/flags`

List knowledge flags

knowledge:readمی‌خواند

Open warnings about pairs of items, newest first. Each item is compared with the closest items at every level when it is indexed, and again whenever it changes. duplicate means two items say nearly the same thing. conflict means the AI found that two closely related items disagree on a fact, such as a price or a deadline, and detail says how. Conflicts are looked for while the workspace setting knowledgeLearning is on, at most 200 times a day. A flag shows only to a caller who can see both items. With itemId, only the flags that name that item.

Requires the knowledge:read scope.

پارامترهای کوئری

itemIdstring: Only the flags that name this knowledge item.
limitinteger: How many flags, from 1 to 100. The server defaults to 50.
دست‌کم 1حداکثر 100پیش‌فرض50

خروجی

200KnowledgeFlagList

The open flags.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.listFlags()
Python: knowledge.list_flags()
Ruby: knowledge.list_flags
PHP: knowledge->listFlags
CLI: openemail knowledge list-flags
MCP: listKnowledgeFlags

POST`/knowledge/flags/{id}/dismiss`

Dismiss a knowledge flag

knowledge:writeداده‌ها را تغییر می‌دهد

Marks the flag dismissed, and the same two items are not flagged for the same reason again. To settle a real duplicate or conflict instead, change or delete one of the items. It needs the reach to change items at the levels of both.

Requires the knowledge:write scope.

پارامترهای مسیر

idstringالزامی: The id of a flag, as GET /knowledge/flags returns it.

خروجی

200KnowledgeFlag

The flag, dismissed.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.dismissFlag()
Python: knowledge.dismiss_flag()
Ruby: knowledge.dismiss_flag
PHP: knowledge->dismissFlag
CLI: openemail knowledge dismiss-flag
MCP: dismissKnowledgeFlag

GET`/knowledge/connectors`

List knowledge connectors

knowledge:readمی‌خواند

Every connector at a level the caller can see, newest first.

Requires the knowledge:read scope.

خروجی

200KnowledgeConnectorList

The connectors.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.listConnectors()
Python: knowledge.list_connectors()
Ruby: knowledge.list_connectors
PHP: knowledge->listConnectors
CLI: openemail knowledge list-connectors
MCP: listKnowledgeConnectors

POST`/knowledge/connectors`

Add a knowledge connector

knowledge:writeداده‌ها را تغییر می‌دهد

Keeps many web pages from one source in the knowledge base, each page as a link item at the connector's level. site reads the page at url and follows its links to pages on the same host under the same path, leaving out what the site's robots.txt disallows. sitemap reads a sitemap, or a sitemap index and up to 5 of its sitemaps. feed reads an RSS or Atom feed. zendesk reads the published articles of a Zendesk help center, from its address such as https://example.zendesk.com. It keeps at most pageLimit pages, 25 unless you say. The first sync starts within a minute, and it syncs again every refreshDays days, 7 unless you say: new pages are added, changed ones are read again and pages that are gone are removed. A page already in the knowledge base as a link at the same level is left to that item. Its items count toward the plan allowance, and a sync stops adding pages once that is reached. Changing an item needs reach over every address its level covers: the whole workspace needs every address, a domain needs the whole domain, and an address needs that address. A key or an app limited to particular addresses can change items only at those addresses, or at domains it holds whole.

Requires the knowledge:write scope.

بدنهٔ درخواست

kindstringالزامی: A site it crawls, a sitemap, an RSS or Atom feed, or a Zendesk help center.
یکی از"site""sitemap""feed""zendesk"
urlstringالزامی: A public https address: the page a site crawl starts from, the sitemap, the feed, or the address of the help center.
1 تا 2048 نویسه
scopestring: A scope is empty for the whole workspace, @ and a domain for everything on that domain (@acme.com), or one address ([email protected]). The AI working for an address reads that address, then its domain, then the whole workspace, the most specific first.
پیش‌فرض""
titlestring: Left out, the host and the kind.
تا 200 نویسه
refreshDaysinteger: Sync again every this many days, 7 when left out. Null syncs only when you ask.
می‌تواند null باشدیکی از1730
pageLimitinteger: The most pages to keep.
دست‌کم 1حداکثر 200پیش‌فرض25

خروجی

201KnowledgeConnector

The connector, queued for its first sync.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.addConnector()
Python: knowledge.add_connector()
Ruby: knowledge.add_connector
PHP: knowledge->addConnector
CLI: openemail knowledge add-connector
MCP: addKnowledgeConnector

GET`/knowledge/connectors/{id}`

Get a knowledge connector

knowledge:readمی‌خواند

The connector, how many items it keeps and when it syncs next.

Requires the knowledge:read scope.

پارامترهای مسیر

idstringالزامی: The id of a connector, as GET /knowledge/connectors returns it.

خروجی

200KnowledgeConnector

The connector.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.getConnector()
Python: knowledge.get_connector()
Ruby: knowledge.get_connector
PHP: knowledge->getConnector
CLI: openemail knowledge get-connector
MCP: getKnowledgeConnector

PATCH`/knowledge/connectors/{id}`

Change a knowledge connector

knowledge:writeداده‌ها را تغییر می‌دهد

Give at least one field. Moving it to another level moves its items with it, and they are indexed again there. Changing an item needs reach over every address its level covers: the whole workspace needs every address, a domain needs the whole domain, and an address needs that address. A key or an app limited to particular addresses can change items only at those addresses, or at domains it holds whole. Moving it needs that reach at both levels.

Requires the knowledge:write scope.

پارامترهای مسیر

idstringالزامی: The id of a connector, as GET /knowledge/connectors returns it.

بدنهٔ درخواست

titlestring: A new name, at most 200 characters.
1 تا 200 نویسه
scopestring: A scope is empty for the whole workspace, @ and a domain for everything on that domain (@acme.com), or one address ([email protected]). The AI working for an address reads that address, then its domain, then the whole workspace, the most specific first.
refreshDaysinteger: Sync again every this many days. Null syncs only when you ask.
می‌تواند null باشدیکی از1730
pageLimitinteger: The most pages to keep, from 1 to 200.
دست‌کم 1حداکثر 200

خروجی

200KnowledgeConnector

The connector as it is now.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.updateConnector()
Python: knowledge.update_connector()
Ruby: knowledge.update_connector
PHP: knowledge->updateConnector
CLI: openemail knowledge update-connector
MCP: updateKnowledgeConnector

DELETE`/knowledge/connectors/{id}`

Delete a knowledge connector

knowledge:writeحذف می‌کند

Gone for good, with every item it added to the knowledge base. The AI stops using them at once.

Requires the knowledge:write scope.

پارامترهای مسیر

idstringالزامی: The id of a connector, as GET /knowledge/connectors returns it.

خروجی

200DeletedKnowledgeConnector

Deleted.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.deleteConnector()
Python: knowledge.delete_connector()
Ruby: knowledge.delete_connector
PHP: knowledge->deleteConnector
CLI: openemail knowledge delete-connector
MCP: deleteKnowledgeConnector

POST`/knowledge/connectors/{id}/sync`

Sync a knowledge connector now

knowledge:writeداده‌ها را تغییر می‌دهد

Queues a sync that starts within a minute, whatever the schedule says, and clears a failure.

Requires the knowledge:write scope.

پارامترهای مسیر

idstringالزامی: The id of a connector, as GET /knowledge/connectors returns it.

خروجی

200KnowledgeConnector

The connector, queued to sync.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.syncConnector()
Python: knowledge.sync_connector()
Ruby: knowledge.sync_connector
PHP: knowledge->syncConnector
CLI: openemail knowledge sync-connector
MCP: syncKnowledgeConnector

POST`/knowledge/drafts`

Draft a note from a conversation

knowledge:writethreads:readمی‌خواند

The AI reads the conversation and writes one note of the facts in it that the team will need again, leaving out personal details and what matters only to that conversation. Nothing is saved: send the draft, changed as you like, to POST /knowledge/notes with the same threadId to keep it. scope suggests a level: the domain the conversation arrived at when the caller may add items there, otherwise the whole workspace or the address. It counts as one AI action.

Requires the knowledge:write and threads:read scopes.

بدنهٔ درخواست

threadIdstringالزامی: The conversation, by the id the thread endpoints give it.
1 تا 200 نویسه

خروجی

200KnowledgeDraft

The draft note.

خطاها

خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها

همچنین در دسترس در

TypeScript: knowledge.draftFromThread()
Python: knowledge.draft_from_thread()
Ruby: knowledge.draft_from_thread
PHP: knowledge->draftFromThread
CLI: openemail knowledge draft-from-thread
MCP: draftKnowledgeFromThread

اشیا

`DeletedKnowledgeConnector`object

objectstring: یکی از"knowledge_connector"
idstring
deletedboolean: یکی ازtrue

`DeletedKnowledgeItem`object

objectstring: یکی از"knowledge_item"
idstring
deletedboolean: یکی ازtrue

`KnowledgeConnector`object

objectstringالزامی: یکی از"knowledge_connector"
idstringالزامی
kindstringالزامی: A site it crawls, a sitemap, an RSS or Atom feed, or a Zendesk help center.
یکی از"site""sitemap""feed""zendesk"
scopestringالزامی: A scope is empty for the whole workspace, @ and a domain for everything on that domain (@acme.com), or one address ([email protected]). The AI working for an address reads that address, then its domain, then the whole workspace, the most specific first.
levelstringالزامی: یکی از"workspace""domain""address"
titlestringالزامی: تا 200 نویسه
urlstringالزامی
refreshDaysintegerالزامی: It syncs again every this many days. Null when it syncs only when you ask.
می‌تواند null باشدیکی از1730
pageLimitintegerالزامی: The most pages it keeps.
statusstringالزامی: queued until a sync starts, syncing while it reads the source, ready once its pages are items, failed when the source could not be read after several tries.
یکی از"queued""syncing""ready""failed"
failurestringالزامی: می‌تواند null باشدیکی از"unsupported""empty""too_large""fetch_failed""blocked_url""conversion_failed""index_failed""over_allowance""missing_file"
itemsintegerالزامی: How many items it keeps in the knowledge base.
lastSyncAtstringالزامی: می‌تواند null باشدقالبdate-time
nextSyncAtstringالزامی: می‌تواند null باشدقالبdate-time
createdAtstringالزامی: قالبdate-time
updatedAtstringالزامی: قالبdate-time

`KnowledgeConnectorList`object

objectstring: یکی از"list"
dataKnowledgeConnector[]

`KnowledgeDraft`object

objectstringالزامی: یکی از"knowledge_draft"
titlestringالزامی
bodystringالزامی: The note, in Markdown.
scopestringالزامی: The suggested level. A scope is empty for the whole workspace, @ and a domain for everything on that domain (@acme.com), or one address ([email protected]). The AI working for an address reads that address, then its domain, then the whole workspace, the most specific first.
threadIdstringالزامی

`KnowledgeFlag`object

objectstringالزامی: یکی از"knowledge_flag"
idstringالزامی
kindstringالزامی: duplicate when the two items say nearly the same thing, conflict when they disagree on a fact.
یکی از"duplicate""conflict"
statusstringالزامی: یکی از"open""dismissed"
sourceIdstringالزامی
sourceTitlestringالزامی
otherSourceIdstringالزامی
otherSourceTitlestringالزامی
detailstringالزامی: For a conflict, one sentence on the facts that disagree. Null for a duplicate.
می‌تواند null باشد
scorenumberالزامی: How close in meaning the two items are, from 0 to 1.
createdAtstringالزامی: قالبdate-time

`KnowledgeFlagList`object

objectstring: یکی از"list"
dataKnowledgeFlag[]

`KnowledgeItem`object

objectstringالزامی: یکی از"knowledge_item"
idstringالزامی
kindstringالزامی: A note written in place, an uploaded file, or a web page fetched from a link.
یکی از"note""file""link"
scopestringالزامی: A scope is empty for the whole workspace, @ and a domain for everything on that domain (@acme.com), or one address ([email protected]). The AI working for an address reads that address, then its domain, then the whole workspace, the most specific first.
levelstringالزامی: یکی از"workspace""domain""address"
titlestringالزامی: تا 200 نویسه
urlstringالزامی: The page a link item reads. Null for notes and files.
می‌تواند null باشد
fileNamestringالزامی: می‌تواند null باشد
mimeTypestringالزامی: می‌تواند null باشد
sizeBytesintegerالزامی: می‌تواند null باشد
pinnedbooleanالزامی: A pinned note goes into every AI prompt at its level, not only when it matches.
statusstringالزامی: queued and processing while the text is read and indexed, ready once the AI can use it, failed when it could not be read. A changed item goes back to queued, and its previous text stays in use until the new one is ready.
یکی از"queued""processing""ready""failed"
failurestringالزامی: می‌تواند null باشدیکی از"unsupported""empty""too_large""fetch_failed""blocked_url""conversion_failed""index_failed""over_allowance""missing_file"
chunksintegerالزامی: How many passages the text was split into for search.
charsintegerالزامی: Characters of text, which count toward the plan allowance.
originstringالزامی: یکی از"app""api""assistant""mcp"
createdBystringالزامی: می‌تواند null باشد
createdAtstringالزامی: قالبdate-time
updatedAtstringالزامی: قالبdate-time
indexedAtstringالزامی: می‌تواند null باشدقالبdate-time
refreshDaysintegerالزامی: Links only: the page is read again every this many days, and changes reach the AI on their own. Null when it is read only when you ask.
می‌تواند null باشدیکی از1730
nextRefreshAtstringالزامی: When the page is next read again. Null when it is not scheduled.
می‌تواند null باشدقالبdate-time
connectorIdstringالزامی: The connector that keeps this item in step with its source, or null for an item added by hand.
می‌تواند null باشد
threadIdstringالزامی: The conversation the note was saved from, or null.
می‌تواند null باشد
usesintegerالزامی: How many times it came up in a reply suggestion, a draft, the assistant or a search.
lastUsedAtstringالزامی: می‌تواند null باشدقالبdate-time
flagsintegerالزامی: How many open duplicate or conflict flags name it. Lists and GET /knowledge/{id} count them, and the answer to a change says 0.

`KnowledgeItemDetail`object

objectstring: یکی از"knowledge_item"
idstring
kindstring: A note written in place, an uploaded file, or a web page fetched from a link.
یکی از"note""file""link"
scopestring: A scope is empty for the whole workspace, @ and a domain for everything on that domain (@acme.com), or one address ([email protected]). The AI working for an address reads that address, then its domain, then the whole workspace, the most specific first.
levelstring: یکی از"workspace""domain""address"
titlestring: تا 200 نویسه
urlstring: The page a link item reads. Null for notes and files.
می‌تواند null باشد
fileNamestring: می‌تواند null باشد
mimeTypestring: می‌تواند null باشد
sizeBytesinteger: می‌تواند null باشد
pinnedboolean: A pinned note goes into every AI prompt at its level, not only when it matches.
statusstring: queued and processing while the text is read and indexed, ready once the AI can use it, failed when it could not be read. A changed item goes back to queued, and its previous text stays in use until the new one is ready.
یکی از"queued""processing""ready""failed"
failurestring: می‌تواند null باشدیکی از"unsupported""empty""too_large""fetch_failed""blocked_url""conversion_failed""index_failed""over_allowance""missing_file"
chunksinteger: How many passages the text was split into for search.
charsinteger: Characters of text, which count toward the plan allowance.
originstring: یکی از"app""api""assistant""mcp"
createdBystring: می‌تواند null باشد
createdAtstring: قالبdate-time
updatedAtstring: قالبdate-time
indexedAtstring: می‌تواند null باشدقالبdate-time
refreshDaysinteger: Links only: the page is read again every this many days, and changes reach the AI on their own. Null when it is read only when you ask.
می‌تواند null باشدیکی از1730
nextRefreshAtstring: When the page is next read again. Null when it is not scheduled.
می‌تواند null باشدقالبdate-time
connectorIdstring: The connector that keeps this item in step with its source, or null for an item added by hand.
می‌تواند null باشد
threadIdstring: The conversation the note was saved from, or null.
می‌تواند null باشد
usesinteger: How many times it came up in a reply suggestion, a draft, the assistant or a search.
lastUsedAtstring: می‌تواند null باشدقالبdate-time
flagsinteger: How many open duplicate or conflict flags name it. Lists and GET /knowledge/{id} count them, and the answer to a change says 0.
bodystring: The text of a note. Null for files and links.
می‌تواند null باشد
previewstring: The text the AI reads, from the start. Null while a file or page has not been read yet.
می‌تواند null باشد
previewTruncatedboolean: True when the text goes on past the preview.

`KnowledgeItemList`object

objectstring: یکی از"list"
dataKnowledgeItem[]
hasMoreboolean: True when another page follows. Pass nextCursor back as cursor to read it.
nextCursorstring: An opaque cursor for the next page, or null on the last page. Pass it back unchanged.
می‌تواند null باشد

`KnowledgeLevel`object

objectstring: یکی از"knowledge_level"
scopestring: A scope is empty for the whole workspace, @ and a domain for everything on that domain (@acme.com), or one address ([email protected]). The AI working for an address reads that address, then its domain, then the whole workspace, the most specific first.
levelstring: یکی از"workspace""domain""address"
writableboolean: Whether the caller may add and change items here.
itemsinteger

`KnowledgeLevelList`object

objectstring: یکی از"list"
dataKnowledgeLevel[]

`KnowledgeSearchHit`object

sourceIdstring: The item the passage comes from.
titlestring
kindstring: یکی از"note""file""link"
scopestring
levelstring: یکی از"workspace""domain""address"
urlstring: می‌تواند null باشد
headingstring: The headings the passage sits under, joined with > .
textstring
scorenumber: Higher is a better match. Only the order means anything.

`KnowledgeSearchResult`object

objectstring: یکی از"knowledge_search"
querystring
hitsKnowledgeSearchHit[]
rerankedboolean: True when the AI put the passages in order, as rerank asks.

`KnowledgeStats`object

objectstring

یکی از"knowledge_stats"

daysinteger

usesinteger

Times the AI found something in the knowledge base.

emptyinteger

Times it looked and found nothing.

coveragenumber

uses divided by uses and empty together, from 0 to 1. 0 when it never looked.

bySurfaceRecord<string, integer>

uses by where they happened: compose, reply, chat, tool, search.

seriesobject[]

One entry per day, oldest first, days with nothing included.

daystring: قالبdate
usesinteger
emptyinteger

topItemsobject[]

The items used most, ever.

idstring
titlestring
kindstring: یکی از"note""file""link"
scopestring
usesinteger
lastUsedAtstring: می‌تواند null باشدقالبdate-time

unusedItemsinteger

Ready items the AI has never used.

pendingSuggestionsinteger

openQuestionsinteger

openFlagsinteger

`KnowledgeSuggestion`object

objectstringالزامی: یکی از"knowledge_suggestion"
idstringالزامی
kindstringالزامی: learned is a fact the AI found in a reply sent from the workspace. question is something a sender asked that nothing in the knowledge base answers.
یکی از"learned""question"
statusstringالزامی: یکی از"pending""accepted""dismissed"
scopestringالزامی: A scope is empty for the whole workspace, @ and a domain for everything on that domain (@acme.com), or one address ([email protected]). The AI working for an address reads that address, then its domain, then the whole workspace, the most specific first.
levelstringالزامی: یکی از"workspace""domain""address"
titlestringالزامی: The suggested title, or the question.
bodystringالزامی: The suggested note. Null for a question, which needs its answer when it is accepted.
می‌تواند null باشد
occurrencesintegerالزامی: How many times the same fact or question came up.
threadIdstringالزامی: The conversation it came from most recently.
می‌تواند null باشد
sourceIdstringالزامی: The note made from it, once it is accepted.
می‌تواند null باشد
createdAtstringالزامی: قالبdate-time
updatedAtstringالزامی: قالبdate-time
decidedAtstringالزامی: می‌تواند null باشدقالبdate-time

`KnowledgeSuggestionAccepted`object

objectstringالزامی: یکی از"knowledge_suggestion_accepted"
suggestionKnowledgeSuggestionالزامی
itemKnowledgeItemالزامی

`KnowledgeSuggestionList`object

objectstring: یکی از"list"
dataKnowledgeSuggestion[]
hasMoreboolean: True when another page follows. Pass nextCursor back as cursor to read it.
nextCursorstring: An opaque cursor for the next page, or null on the last page. Pass it back unchanged.
می‌تواند null باشد

`KnowledgeUsage`object

objectstring

یکی از"knowledge_usage"

planstring

یکی از"free""starter""business""enterprise"

sourcesinteger

Items held.

charsinteger

Characters of text held.

limitsobject

sourcesinteger
charsinteger