optimal_engine_export
For an Optimal Engine you run locally: the documents to POST, one by one, to <engine>/api/ingest with your engine key. Returns { engine, ingestPath, documents, truncated }. Needs an editor key.
Write · editor keyMCP tool
Parameters
- workspacestringrequired
Workspace slug
- companystringoptional
Company slug; omit for every company (send, export) or the client (pull, import). For pull and import a domain adds the company once.
max 200 chars
Example call
Agents call tools by name; you rarely write this by hand. It is here so you can test the server from a shell or your own code.
{
"name": "optimal_engine_export",
"arguments": {
"workspace": "acme-builders"
}
}Response
The result is one text content block holding this JSON (abbreviated here). Errors come back with isError: true and a message such as Error 401: … or Invalid input: ….
Response
{
"ingestPath": "/api/ingest",
"documents": [],
"truncated": false
}Over REST
The same call without MCP: GET/api/v1/workspaces/:slug/optimal-engine/export