{"openapi":"3.1.0","info":{"title":"Sim Knowledge (BYOK) API","version":"0.1.0","description":"Sim Knowledge (BYOK) lets an AI assistant read your own Sim Knowledge data through the Sim Knowledge API with a key you supply (Sim API key (personal or workspace)). Read-only: 8 tools (list_knowledge_bases, get_knowledge_base, list_knowledge_connectors, list_knowledge_documents, list_knowledge_tags, list_knowledge_folders, list_tables, get_table). The BYOK key travels with each request, is used...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-sim-knowledge.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-sim-knowledge/docs"},"termsOfService":"https://connectorbay.com/byok-sim-knowledge/terms"},"servers":[{"url":"https://byok-sim-knowledge.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-sim-knowledge/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_knowledge_bases":{"post":{"operationId":"list_knowledge_bases","summary":"List knowledge bases in a workspace with document count, token count, embedding model, chunking strategy, connector type","description":"List knowledge bases in a workspace with document count, token count, embedding model, chunking strategy, connector types and dates. Use for \"Which Sim knowledge bases do I have and how big are they\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id from the Sim app URL or the Sim Workspace connector.","maxLength":100,"title":"Workspace Id","type":"string"},"scope":{"anyOf":[{"enum":["active","archived"],"type":"string"},{"type":"null"}],"default":"active","description":"active (default) or archived knowledge bases.","title":"Scope"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to match in names.","title":"Search"},"sort_by":{"anyOf":[{"enum":["name","createdAt","updatedAt"],"type":"string"},{"type":"null"}],"default":"createdAt","description":"Order by name, createdAt or updatedAt.","title":"Sort By"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"asc","description":"asc or desc.","title":"Sort Order"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 100, default 50).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from nextCursor of the previous answer; leave empty for the first page.","title":"Cursor"}},"required":["workspace_id"],"title":"list_knowledge_basesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_knowledge_base":{"post":{"operationId":"get_knowledge_base","summary":"Get one knowledge base's settings and size by id. Use for \"What embedding model does Sim knowledge base kb_123 use\".","description":"Get one knowledge base's settings and size by id. Use for \"What embedding model does Sim knowledge base kb_123 use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"knowledge_base_id":{"description":"Knowledge base id from list_knowledge_bases.","maxLength":200,"title":"Knowledge Base Id","type":"string"},"workspace_id":{"description":"Workspace id from the Sim app URL or the Sim Workspace connector.","maxLength":100,"title":"Workspace Id","type":"string"}},"required":["knowledge_base_id","workspace_id"],"title":"get_knowledge_baseArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_knowledge_connectors":{"post":{"operationId":"list_knowledge_connectors","summary":"List the sync connectors of a knowledge base with type, sync mode, interval, status, last sync time and error (source se","description":"List the sync connectors of a knowledge base with type, sync mode, interval, status, last sync time and error (source settings are not returned). Use for \"Is the Notion sync of Sim knowledge base kb_123 healthy\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"knowledge_base_id":{"description":"Knowledge base id from list_knowledge_bases.","maxLength":200,"title":"Knowledge Base Id","type":"string"},"workspace_id":{"description":"Workspace id from the Sim app URL or the Sim Workspace connector.","maxLength":100,"title":"Workspace Id","type":"string"},"sort_by":{"anyOf":[{"enum":["connectorType","createdAt","updatedAt"],"type":"string"},{"type":"null"}],"default":"createdAt","description":"Order by connectorType, createdAt or updatedAt.","title":"Sort By"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"asc or desc.","title":"Sort Order"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 100, default 50).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from nextCursor of the previous answer; leave empty for the first page.","title":"Cursor"}},"required":["knowledge_base_id","workspace_id"],"title":"list_knowledge_connectorsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_knowledge_documents":{"post":{"operationId":"list_knowledge_documents","summary":"List the documents of a knowledge base with file name, size, type, processing status, chunk and token counts and enabled","description":"List the documents of a knowledge base with file name, size, type, processing status, chunk and token counts and enabled flag (no text). Use for \"Which documents in Sim knowledge base kb_123 failed processing\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"knowledge_base_id":{"description":"Knowledge base id from list_knowledge_bases.","maxLength":200,"title":"Knowledge Base Id","type":"string"},"workspace_id":{"description":"Workspace id from the Sim app URL or the Sim Workspace connector.","maxLength":100,"title":"Workspace Id","type":"string"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to match in file names.","title":"Search"},"enabled_filter":{"anyOf":[{"enum":["all","enabled","disabled"],"type":"string"},{"type":"null"}],"default":"all","description":"all (default), enabled or disabled documents.","title":"Enabled Filter"},"sort_by":{"anyOf":[{"enum":["filename","fileSize","tokenCount","chunkCount","uploadedAt","processingStatus","enabled"],"type":"string"},{"type":"null"}],"default":"uploadedAt","description":"Order by filename, fileSize, tokenCount, chunkCount, uploadedAt, processingStatus or enabled.","title":"Sort By"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"asc or desc.","title":"Sort Order"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 100, default 50).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from nextCursor of the previous answer; leave empty for the first page.","title":"Cursor"}},"required":["knowledge_base_id","workspace_id"],"title":"list_knowledge_documentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_knowledge_tags":{"post":{"operationId":"list_knowledge_tags","summary":"List the tag definitions of a knowledge base (display name, slot and field type). Use for \"Which tags can I filter Sim k","description":"List the tag definitions of a knowledge base (display name, slot and field type). Use for \"Which tags can I filter Sim knowledge base kb_123 by\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"knowledge_base_id":{"description":"Knowledge base id from list_knowledge_bases.","maxLength":200,"title":"Knowledge Base Id","type":"string"},"workspace_id":{"description":"Workspace id from the Sim app URL or the Sim Workspace connector.","maxLength":100,"title":"Workspace Id","type":"string"}},"required":["knowledge_base_id","workspace_id"],"title":"list_knowledge_tagsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_knowledge_folders":{"post":{"operationId":"list_knowledge_folders","summary":"List knowledge base folders with path, parent path and dates. Use for \"How are my Sim knowledge bases organized into fol","description":"List knowledge base folders with path, parent path and dates. Use for \"How are my Sim knowledge bases organized into folders\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id from the Sim app URL or the Sim Workspace connector.","maxLength":100,"title":"Workspace Id","type":"string"},"parent_path":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only folders under this path.","title":"Parent Path"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to match in folder names.","title":"Search"}},"required":["workspace_id"],"title":"list_knowledge_foldersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_tables":{"post":{"operationId":"list_tables","summary":"List tables in a workspace with row count, row limit, column schema, lock flags and dates (no rows). Use for \"Which Sim ","description":"List tables in a workspace with row count, row limit, column schema, lock flags and dates (no rows). Use for \"Which Sim tables do I have and how many rows are in each\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id from the Sim app URL or the Sim Workspace connector.","maxLength":100,"title":"Workspace Id","type":"string"},"scope":{"anyOf":[{"enum":["active","archived"],"type":"string"},{"type":"null"}],"default":"active","description":"active (default) or archived tables.","title":"Scope"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to match in names.","title":"Search"},"sort_by":{"anyOf":[{"enum":["name","createdAt","updatedAt"],"type":"string"},{"type":"null"}],"default":"createdAt","description":"Order by name, createdAt or updatedAt.","title":"Sort By"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"asc","description":"asc or desc.","title":"Sort Order"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many results to return (default 100).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from nextCursor of the previous answer; leave empty for the first page.","title":"Cursor"}},"required":["workspace_id"],"title":"list_tablesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_table":{"post":{"operationId":"get_table","summary":"Get one table's column schema, row count, row limit, lock flags and running job state by id (no rows). Use for \"What col","description":"Get one table's column schema, row count, row limit, lock flags and running job state by id (no rows). Use for \"What columns does Sim table tb_123 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"table_id":{"description":"Table id from list_tables.","maxLength":200,"title":"Table Id","type":"string"},"workspace_id":{"description":"Workspace id from the Sim app URL or the Sim Workspace connector.","maxLength":100,"title":"Workspace Id","type":"string"}},"required":["table_id","workspace_id"],"title":"get_tableArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}