API

Knowledge

Every operation in this group: what it accepts, what it returns and the errors it can answer with.

Operations

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:readReads

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.

Query parameters

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.
One of"workspace""domain""address"
kindstring: Keeps one kind of item: note, file or link.
One of"note""file""link"
statusstring: Keeps one status: queued, processing, ready or failed.
One of"queued""processing""ready""failed"
pinnedstring: true keeps the pinned notes and false everything else.
One of"true""false"
qstring: Words in the title, file name or link.
limitinteger: Rows per page, 1 to 100.
At least 1At most 100Default25
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.

Returns

200KnowledgeItemList

A page of items.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:readReads

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.

Returns

200KnowledgeLevelList

Every level the caller can see.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:readReads

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

Requires the knowledge:read scope.

Returns

200KnowledgeUsage

The usage and the limits.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:readReads

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.

Request body

querystringRequired: What to look for, in plain words, up to 500 characters.
1 to 500 characters
addressstring: An address of the workspace, to search the levels the AI uses when it writes as that address.
Up to 320 characters
scopestring: One level to search: an empty string for the whole workspace, @ and a domain, or one address.
Up to 320 characters
limitinteger: How many passages, from 1 to 25. The server defaults to 8.
At least 1At most 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.

Returns

200KnowledgeSearchResult

The passages, best first.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:writeChanges data

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.

Request body

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].
Up to 320 charactersDefault""
titlestringRequired: A short name for the note, at most 200 characters.
1 to 200 characters
bodystringRequired: The text, up to 20,000 characters, in Markdown if you like.
1 to 20000 characters
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 to 200 characters

Returns

201KnowledgeItem

The note.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:writeChanges data

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.

Request body

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].
Up to 320 charactersDefault""
urlstringRequired: The page, a public http or https address of at most 2,048 characters.
1 to 2048 characters
titlestring: A name for the item, at most 200 characters. Left out, the page's own title once it has been read.
Up to 200 characters
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.
Can be nullMore than 0

Returns

201KnowledgeItem

The link, queued to be read.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:writeChanges data

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.

Query parameters

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.
Up to 200 characters

Request body

Content typeapplication/octet-stream

binary

Returns

201KnowledgeItem

The file, queued to be read.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:readReads

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.

Path parameters

idstringRequired: The id of a knowledge item, as GET /knowledge returns it.

Returns

200KnowledgeItemDetail

The item and its text.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:writeChanges data

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.

Path parameters

idstringRequired: The id of a knowledge item, as GET /knowledge returns it.

Request body

titlestring: A new name, at most 200 characters.
1 to 200 characters
bodystring: Notes only.
1 to 20000 characters
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 to 2048 characters
refreshDaysinteger: Links only: read the page again every this many days. Null stops that.
Can be nullOne of1730

Returns

200KnowledgeItem

The item as it is now.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:writeDeletes

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

Requires the knowledge:write scope.

Path parameters

idstringRequired: The id of a knowledge item, as GET /knowledge returns it.

Returns

200DeletedKnowledgeItem

Deleted.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:writeChanges data

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.

Path parameters

idstringRequired: The id of a knowledge item, as GET /knowledge returns it.

Returns

200KnowledgeItem

The item, queued to be read again.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:readReads

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.

Query parameters

daysinteger: How many days back to count, today included.
At least 1At most 90Default30

Returns

200KnowledgeStats

The stats.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:readReads

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.

Query parameters

kindstring: Keeps one kind: learned for notes drawn from sent replies, or question for questions nothing answers.
One of"learned""question"
statusstring: Keeps one status: pending, accepted or dismissed. Left out, pending.
One of"pending""accepted""dismissed"Default"pending"
limitinteger: Rows per page, 1 to 100.
At least 1At most 100Default25
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.

Returns

200KnowledgeSuggestionList

A page of suggestions and questions.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:writeChanges data

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.

Path parameters

idstringRequired: The id of a suggestion or question, as GET /knowledge/suggestions returns it.

Request body

titlestring: Left out, the suggested title or the question.
1 to 200 characters
bodystring: Left out, the suggested note. A question needs it: the answer.
1 to 20000 characters
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.

Returns

200KnowledgeSuggestionAccepted

The suggestion and the note made from it.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:writeChanges data

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.

Path parameters

idstringRequired: The id of a suggestion or question, as GET /knowledge/suggestions returns it.

Returns

200KnowledgeSuggestion

The suggestion, dismissed.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:readReads

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.

Query parameters

itemIdstring: Only the flags that name this knowledge item.
limitinteger: How many flags, from 1 to 100. The server defaults to 50.
At least 1At most 100Default50

Returns

200KnowledgeFlagList

The open flags.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:writeChanges data

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.

Path parameters

idstringRequired: The id of a flag, as GET /knowledge/flags returns it.

Returns

200KnowledgeFlag

The flag, dismissed.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:readReads

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

Requires the knowledge:read scope.

Returns

200KnowledgeConnectorList

The connectors.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:writeChanges data

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.

Request body

kindstringRequired: A site it crawls, a sitemap, an RSS or Atom feed, or a Zendesk help center.
One of"site""sitemap""feed""zendesk"
urlstringRequired: A public https address: the page a site crawl starts from, the sitemap, the feed, or the address of the help center.
1 to 2048 characters
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.
Default""
titlestring: Left out, the host and the kind.
Up to 200 characters
refreshDaysinteger: Sync again every this many days, 7 when left out. Null syncs only when you ask.
Can be nullOne of1730
pageLimitinteger: The most pages to keep.
At least 1At most 200Default25

Returns

201KnowledgeConnector

The connector, queued for its first sync.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:readReads

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

Requires the knowledge:read scope.

Path parameters

idstringRequired: The id of a connector, as GET /knowledge/connectors returns it.

Returns

200KnowledgeConnector

The connector.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:writeChanges data

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.

Path parameters

idstringRequired: The id of a connector, as GET /knowledge/connectors returns it.

Request body

titlestring: A new name, at most 200 characters.
1 to 200 characters
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.
Can be nullOne of1730
pageLimitinteger: The most pages to keep, from 1 to 200.
At least 1At most 200

Returns

200KnowledgeConnector

The connector as it is now.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:writeDeletes

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

Requires the knowledge:write scope.

Path parameters

idstringRequired: The id of a connector, as GET /knowledge/connectors returns it.

Returns

200DeletedKnowledgeConnector

Deleted.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:writeChanges data

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

Requires the knowledge:write scope.

Path parameters

idstringRequired: The id of a connector, as GET /knowledge/connectors returns it.

Returns

200KnowledgeConnector

The connector, queued to sync.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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:readReads

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.

Request body

threadIdstringRequired: The conversation, by the id the thread endpoints give it.
1 to 200 characters

Returns

200KnowledgeDraft

The draft note.

Errors

The errors every operation can return400401403404422500Error catalog

Also available in

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

Objects

`DeletedKnowledgeConnector`object

objectstring: One of"knowledge_connector"
idstring
deletedboolean: One oftrue

`DeletedKnowledgeItem`object

objectstring: One of"knowledge_item"
idstring
deletedboolean: One oftrue

`KnowledgeConnector`object

objectstringRequired: One of"knowledge_connector"
idstringRequired
kindstringRequired: A site it crawls, a sitemap, an RSS or Atom feed, or a Zendesk help center.
One of"site""sitemap""feed""zendesk"
scopestringRequired: 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.
levelstringRequired: One of"workspace""domain""address"
titlestringRequired: Up to 200 characters
urlstringRequired
refreshDaysintegerRequired: It syncs again every this many days. Null when it syncs only when you ask.
Can be nullOne of1730
pageLimitintegerRequired: The most pages it keeps.
statusstringRequired: 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.
One of"queued""syncing""ready""failed"
failurestringRequired: Can be nullOne of"unsupported""empty""too_large""fetch_failed""blocked_url""conversion_failed""index_failed""over_allowance""missing_file"
itemsintegerRequired: How many items it keeps in the knowledge base.
lastSyncAtstringRequired: Can be nullFormatdate-time
nextSyncAtstringRequired: Can be nullFormatdate-time
createdAtstringRequired: Formatdate-time
updatedAtstringRequired: Formatdate-time

`KnowledgeConnectorList`object

objectstring: One of"list"
dataKnowledgeConnector[]

`KnowledgeDraft`object

objectstringRequired: One of"knowledge_draft"
titlestringRequired
bodystringRequired: The note, in Markdown.
scopestringRequired: 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.
threadIdstringRequired

`KnowledgeFlag`object

objectstringRequired: One of"knowledge_flag"
idstringRequired
kindstringRequired: duplicate when the two items say nearly the same thing, conflict when they disagree on a fact.
One of"duplicate""conflict"
statusstringRequired: One of"open""dismissed"
sourceIdstringRequired
sourceTitlestringRequired
otherSourceIdstringRequired
otherSourceTitlestringRequired
detailstringRequired: For a conflict, one sentence on the facts that disagree. Null for a duplicate.
Can be null
scorenumberRequired: How close in meaning the two items are, from 0 to 1.
createdAtstringRequired: Formatdate-time

`KnowledgeFlagList`object

objectstring: One of"list"
dataKnowledgeFlag[]

`KnowledgeItem`object

objectstringRequired: One of"knowledge_item"
idstringRequired
kindstringRequired: A note written in place, an uploaded file, or a web page fetched from a link.
One of"note""file""link"
scopestringRequired: 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.
levelstringRequired: One of"workspace""domain""address"
titlestringRequired: Up to 200 characters
urlstringRequired: The page a link item reads. Null for notes and files.
Can be null
fileNamestringRequired: Can be null
mimeTypestringRequired: Can be null
sizeBytesintegerRequired: Can be null
pinnedbooleanRequired: A pinned note goes into every AI prompt at its level, not only when it matches.
statusstringRequired: 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.
One of"queued""processing""ready""failed"
failurestringRequired: Can be nullOne of"unsupported""empty""too_large""fetch_failed""blocked_url""conversion_failed""index_failed""over_allowance""missing_file"
chunksintegerRequired: How many passages the text was split into for search.
charsintegerRequired: Characters of text, which count toward the plan allowance.
originstringRequired: One of"app""api""assistant""mcp"
createdBystringRequired: Can be null
createdAtstringRequired: Formatdate-time
updatedAtstringRequired: Formatdate-time
indexedAtstringRequired: Can be nullFormatdate-time
refreshDaysintegerRequired: 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.
Can be nullOne of1730
nextRefreshAtstringRequired: When the page is next read again. Null when it is not scheduled.
Can be nullFormatdate-time
connectorIdstringRequired: The connector that keeps this item in step with its source, or null for an item added by hand.
Can be null
threadIdstringRequired: The conversation the note was saved from, or null.
Can be null
usesintegerRequired: How many times it came up in a reply suggestion, a draft, the assistant or a search.
lastUsedAtstringRequired: Can be nullFormatdate-time
flagsintegerRequired: 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: One of"knowledge_item"
idstring
kindstring: A note written in place, an uploaded file, or a web page fetched from a link.
One of"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: One of"workspace""domain""address"
titlestring: Up to 200 characters
urlstring: The page a link item reads. Null for notes and files.
Can be null
fileNamestring: Can be null
mimeTypestring: Can be null
sizeBytesinteger: Can be 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.
One of"queued""processing""ready""failed"
failurestring: Can be nullOne of"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: One of"app""api""assistant""mcp"
createdBystring: Can be null
createdAtstring: Formatdate-time
updatedAtstring: Formatdate-time
indexedAtstring: Can be nullFormatdate-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.
Can be nullOne of1730
nextRefreshAtstring: When the page is next read again. Null when it is not scheduled.
Can be nullFormatdate-time
connectorIdstring: The connector that keeps this item in step with its source, or null for an item added by hand.
Can be null
threadIdstring: The conversation the note was saved from, or null.
Can be null
usesinteger: How many times it came up in a reply suggestion, a draft, the assistant or a search.
lastUsedAtstring: Can be nullFormatdate-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.
Can be null
previewstring: The text the AI reads, from the start. Null while a file or page has not been read yet.
Can be null
previewTruncatedboolean: True when the text goes on past the preview.

`KnowledgeItemList`object

objectstring: One of"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.
Can be null

`KnowledgeLevel`object

objectstring: One of"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: One of"workspace""domain""address"
writableboolean: Whether the caller may add and change items here.
itemsinteger

`KnowledgeLevelList`object

objectstring: One of"list"
dataKnowledgeLevel[]

`KnowledgeSearchHit`object

sourceIdstring: The item the passage comes from.
titlestring
kindstring: One of"note""file""link"
scopestring
levelstring: One of"workspace""domain""address"
urlstring: Can be 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: One of"knowledge_search"
querystring
hitsKnowledgeSearchHit[]
rerankedboolean: True when the AI put the passages in order, as rerank asks.

`KnowledgeStats`object

objectstring

One of"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: Formatdate
usesinteger
emptyinteger

topItemsobject[]

The items used most, ever.

idstring
titlestring
kindstring: One of"note""file""link"
scopestring
usesinteger
lastUsedAtstring: Can be nullFormatdate-time

unusedItemsinteger

Ready items the AI has never used.

pendingSuggestionsinteger

openQuestionsinteger

openFlagsinteger

`KnowledgeSuggestion`object

objectstringRequired: One of"knowledge_suggestion"
idstringRequired
kindstringRequired: 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.
One of"learned""question"
statusstringRequired: One of"pending""accepted""dismissed"
scopestringRequired: 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.
levelstringRequired: One of"workspace""domain""address"
titlestringRequired: The suggested title, or the question.
bodystringRequired: The suggested note. Null for a question, which needs its answer when it is accepted.
Can be null
occurrencesintegerRequired: How many times the same fact or question came up.
threadIdstringRequired: The conversation it came from most recently.
Can be null
sourceIdstringRequired: The note made from it, once it is accepted.
Can be null
createdAtstringRequired: Formatdate-time
updatedAtstringRequired: Formatdate-time
decidedAtstringRequired: Can be nullFormatdate-time

`KnowledgeSuggestionAccepted`object

objectstringRequired: One of"knowledge_suggestion_accepted"
suggestionKnowledgeSuggestionRequired
itemKnowledgeItemRequired

`KnowledgeSuggestionList`object

objectstring: One of"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.
Can be null

`KnowledgeUsage`object

objectstring

One of"knowledge_usage"

planstring

One of"free""starter""business""enterprise"

sourcesinteger

Items held.

charsinteger

Characters of text held.

limitsobject

sourcesinteger
charsinteger