{"openapi":"3.1.0","info":{"title":"Sim Agent Tools (BYOK) API","version":"0.1.0","description":"Sim Agent Tools (BYOK) lets an AI assistant read your own Sim Agent Tools data through the Sim Agent Tools API with a key you supply (Sim API key (personal or workspace)). Read-only: 8 tools (list_mcp_servers, list_mcp_server_tools, list_workflow_mcp_servers, list_skills, list_custom_tools, list_sandboxes, list_blocks, list_tools). The BYOK key travels with each request, is used for that one call...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-sim-agent-tools.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-sim-agent-tools/docs"},"termsOfService":"https://connectorbay.com/byok-sim-agent-tools/terms"},"servers":[{"url":"https://byok-sim-agent-tools.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-sim-agent-tools/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_mcp_servers":{"post":{"operationId":"list_mcp_servers","summary":"List external MCP servers connected to a workspace with URL, transport, auth type, enabled flag, connection status, last","description":"List external MCP servers connected to a workspace with URL, transport, auth type, enabled flag, connection status, last error and tool count. Use for \"Which MCP servers are connected to my Sim workspace and are they healthy\".","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"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to match in names and descriptions.","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":null,"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_mcp_serversArguments","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_mcp_server_tools":{"post":{"operationId":"list_mcp_server_tools","summary":"List the cached tools of one connected MCP server with name and description (the live refresh option is not exposed). Us","description":"List the cached tools of one connected MCP server with name and description (the live refresh option is not exposed). Use for \"What tools does Sim MCP server mcp_1 offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mcp_server_id":{"description":"MCP server id from list_mcp_servers.","maxLength":200,"title":"Mcp Server 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":["mcp_server_id","workspace_id"],"title":"list_mcp_server_toolsArguments","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_workflow_mcp_servers":{"post":{"operationId":"list_workflow_mcp_servers","summary":"List MCP servers that Sim exposes from your workflows, with public flag, URL, tool count and tool names. Use for \"Which ","description":"List MCP servers that Sim exposes from your workflows, with public flag, URL, tool count and tool names. Use for \"Which of my Sim workflows are published as an MCP server\".","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"},"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":null,"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_workflow_mcp_serversArguments","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_skills":{"post":{"operationId":"list_skills","summary":"List agent skills in a workspace with name, description, read-only flag and dates. Use for \"Which skills do my Sim agent","description":"List agent skills in a workspace with name, description, read-only flag and dates. Use for \"Which skills do my Sim agents have\".","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"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to match in names and descriptions.","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":null,"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_skillsArguments","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_custom_tools":{"post":{"operationId":"list_custom_tools","summary":"List custom tools in a workspace with title and function name and description (code is not returned). Use for \"What cust","description":"List custom tools in a workspace with title and function name and description (code is not returned). Use for \"What custom tools exist in my Sim workspace\".","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"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to match in names and descriptions.","title":"Search"},"sort_by":{"anyOf":[{"enum":["title","createdAt","updatedAt"],"type":"string"},{"type":"null"}],"default":"createdAt","description":"Order by title, createdAt or updatedAt.","title":"Sort By"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"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_custom_toolsArguments","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_sandboxes":{"post":{"operationId":"list_sandboxes","summary":"List code sandboxes with language, dependencies, CLI tools, build status and dates. Use for \"Which Sim sandboxes are bui","description":"List code sandboxes with language, dependencies, CLI tools, build status and dates. Use for \"Which Sim sandboxes are built and ready\".","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"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to match in names and descriptions.","title":"Search"},"sort_by":{"anyOf":[{"enum":["name","createdAt","updatedAt"],"type":"string"},{"type":"null"}],"default":"name","description":"Order by name, createdAt or updatedAt.","title":"Sort By"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"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_sandboxesArguments","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_blocks":{"post":{"operationId":"list_blocks","summary":"List the workflow building blocks (blocks, tools and triggers) available in a workspace with category, source, trigger c","description":"List the workflow building blocks (blocks, tools and triggers) available in a workspace with category, source, trigger capability and docs link. Use for \"Which trigger blocks can I use in Sim\".","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"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to match in names and descriptions.","title":"Search"},"category":{"anyOf":[{"enum":["blocks","tools","triggers"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this category: blocks, tools or triggers.","title":"Category"},"source":{"anyOf":[{"enum":["builtin","custom"],"type":"string"},{"type":"null"}],"default":null,"description":"Only builtin or custom blocks.","title":"Source"},"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_blocksArguments","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_tools":{"post":{"operationId":"list_tools","summary":"List the integration tools the workspace can call, with version, hosted-key mode and OAuth requirement. Use for \"Which S","description":"List the integration tools the workspace can call, with version, hosted-key mode and OAuth requirement. Use for \"Which Sim tools need OAuth\".","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"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to match in names and descriptions.","title":"Search"},"hosted_api_key":{"anyOf":[{"enum":["always","conditional","none"],"type":"string"},{"type":"null"}],"default":null,"description":"Only tools whose hosted-key mode is always, conditional or none.","title":"Hosted Api Key"},"oauth_provider":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only tools that use this OAuth provider.","title":"Oauth Provider"},"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_toolsArguments","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}}}}