{"openapi":"3.1.0","info":{"title":"Workato (BYOK) API","version":"0.1.0","description":"Workato (BYOK) lets an AI assistant read your own Workato data through the Workato API with a key you supply (Workato API client token (US data center)). Read-only: 11 tools (get_workspace_user, list_recipes, list_recipe_jobs, list_connections, list_folders, list_projects, list_genies, list_genie_conversations, list_knowledge_bases, list_skills, list_data_tables). The BYOK key travels with each...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-workato.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-workato/docs"},"termsOfService":"https://connectorbay.com/byok-workato/terms"},"servers":[{"url":"https://byok-workato.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-workato/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/get_workspace_user":{"post":{"operationId":"get_workspace_user","summary":"Show the Workato user the token belongs to: name, plan, number of recipes and active recipes and the root folder id. Use","description":"Show the Workato user the token belongs to: name, plan, number of recipes and active recipes and the root folder id. Use for \"Which Workato account is my token for, and how many recipes are active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_workspace_userArguments","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_recipes":{"post":{"operationId":"list_recipes","summary":"List recipes (newest id first) with trigger and action apps, running flag, job success and failure counts, last run and ","description":"List recipes (newest id first) with trigger and action apps, running flag, job success and failure counts, last run and stop cause. Recipe code is left out. Use for \"Which Workato recipes are running and which have failed jobs\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in this folder id.","title":"Folder Id"},"with_subfolders":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include recipes from subfolders of folder_id.","title":"With Subfolders"},"running":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to return only running recipes.","title":"Running"},"order":{"anyOf":[{"enum":["activity","default"],"type":"string"},{"type":"null"}],"default":null,"description":"Order by activity or default.","title":"Order"},"stop_cause":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only recipes stopped for this reason, for example trigger_errors_limit or action_quota_limit.","title":"Stop Cause"},"updated_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items updated after this ISO 8601 time, for example 2026-01-01T00:00:00Z.","title":"Updated After"},"exclude_code":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True to leave out recipe code and config (recommended, keeps answers small).","title":"Exclude Code"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many results per page (1 to 100).","title":"Per Page"}},"title":"list_recipesArguments","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_recipe_jobs":{"post":{"operationId":"list_recipe_jobs","summary":"List recent jobs (runs) of one recipe with status, start and finish time and error text; filter by status. Job input and","description":"List recent jobs (runs) of one recipe with status, start and finish time and error text; filter by status. Job input and output data are not included. Use for \"Did the latest jobs of Workato recipe 66876978 fail\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"recipe_id":{"description":"Numeric id of the recipe, from list_recipes.","title":"Recipe Id","type":"integer"},"status":{"anyOf":[{"enum":["succeeded","failed","pending"],"type":"string"},{"type":"null"}],"default":null,"description":"Only jobs with this status.","title":"Status"},"offset_job_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Job id to page from; returns up to 1000 jobs before (or after, with prev=true) it.","title":"Offset Job Id"},"prev":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to return jobs newer than offset_job_id instead of older.","title":"Prev"}},"required":["recipe_id"],"title":"list_recipe_jobsArguments","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_connections":{"post":{"operationId":"list_connections","summary":"List connections (authorized app accounts) with app, name, authorization status and any connection-lost reason. Credenti","description":"List connections (authorized app accounts) with app, name, authorization status and any connection-lost reason. Credentials are never returned. Use for \"Which Workato connections are broken or unauthorized\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in this folder id.","title":"Folder Id"},"project_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in this project id.","title":"Project Id"},"external_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only connections with this external id.","title":"External Id"},"updated_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items updated after this ISO 8601 time, for example 2026-01-01T00:00:00Z.","title":"Updated After"},"include_runtime_connections":{"anyOf":[{"enum":["true","false"],"type":"string"},{"type":"null"}],"default":null,"description":"Pass true to include runtime user connections.","title":"Include Runtime Connections"}},"title":"list_connectionsArguments","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_folders":{"post":{"operationId":"list_folders","summary":"List folders (children of the Home folder by default) with name, parent, whether it is a project, and dates. Use for \"Wh","description":"List folders (children of the Home folder by default) with name, parent, whether it is a project, and dates. Use for \"What folders are in my Workato workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"parent_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Parent folder id; defaults to the Home folder.","title":"Parent Id"},"with_nested_folders":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include nested folders, not just immediate children.","title":"With Nested Folders"},"updated_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items updated after this ISO 8601 time, for example 2026-01-01T00:00:00Z.","title":"Updated After"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many results per page (1 to 100).","title":"Per Page"}},"title":"list_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_projects":{"post":{"operationId":"list_projects","summary":"List projects (top-level folders that hold one use case) with name, description and folder id. Use for \"Which Workato pr","description":"List projects (top-level folders that hold one use case) with name, description and folder id. Use for \"Which Workato projects do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"updated_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items updated after this ISO 8601 time, for example 2026-01-01T00:00:00Z.","title":"Updated After"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many results per page (1 to 100).","title":"Per Page"}},"title":"list_projectsArguments","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_genies":{"post":{"operationId":"list_genies","summary":"List Agent Studio genies (AI agents) with state, chat interface, AI provider and counts of skills and knowledge bases. U","description":"List Agent Studio genies (AI agents) with state, chat interface, AI provider and counts of skills and knowledge bases. Use for \"Which Workato genies are active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in this folder id.","title":"Folder Id"},"project_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in this project id.","title":"Project Id"},"state":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only genies in this state, for example active or inactive.","title":"State"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results per page (1 to 50).","title":"Per Page"}},"title":"list_geniesArguments","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_genie_conversations":{"post":{"operationId":"list_genie_conversations","summary":"List a genie's conversations, most recent first, with topic, source app and times (event detail is not included). Use fo","description":"List a genie's conversations, most recent first, with topic, source app and times (event detail is not included). Use for \"What conversations has Workato genie gin-BWLSPX4z-BaT3D9 had\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"genie_id":{"description":"Handle of the genie, for example gin-BWLSPX4z-BaT3D9, from list_genies.","maxLength":200,"title":"Genie Id","type":"string"},"page_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's next_cursor.","title":"Page After"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Conversations per page (1 to 100).","title":"Page Size"},"from_time":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only conversations created at or after this ISO 8601 time.","title":"From Time"},"to_time":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only conversations created at or before this ISO 8601 time.","title":"To Time"},"app_type":{"anyOf":[{"enum":["slack","teams","go","headless_api","test_mode","genie_task","app_event"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this trigger source.","title":"App Type"}},"required":["genie_id"],"title":"list_genie_conversationsArguments","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_bases":{"post":{"operationId":"list_knowledge_bases","summary":"List Agent Studio knowledge bases with name, description, folder and project. Use for \"Which Workato knowledge bases exi","description":"List Agent Studio knowledge bases with name, description, folder and project. Use for \"Which Workato knowledge bases exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in this folder id.","title":"Folder Id"},"project_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in this project id.","title":"Project Id"},"query":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Search text.","title":"Query"},"sort_term":{"anyOf":[{"enum":["name","latest_activity"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort by name or latest_activity.","title":"Sort Term"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results per page (1 to 50).","title":"Per Page"}},"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/list_skills":{"post":{"operationId":"list_skills","summary":"List Agent Studio skills (tasks a genie can run) with name, description, folder and project. Use for \"Which Workato skil","description":"List Agent Studio skills (tasks a genie can run) with name, description, folder and project. Use for \"Which Workato skills can my genies use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in this folder id.","title":"Folder Id"},"project_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in this project id.","title":"Project Id"},"query":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Search text.","title":"Query"},"sort_term":{"anyOf":[{"enum":["name","latest_activity"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort by name or latest_activity.","title":"Sort Term"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results per page (1 to 50).","title":"Per Page"}},"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_data_tables":{"post":{"operationId":"list_data_tables","summary":"List data tables with id and name (the field list is included for each table). Use for \"What data tables do I have in Wo","description":"List data tables with id and name (the field list is included for each table). Use for \"What data tables do I have in Workato\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many results per page (1 to 100).","title":"Per Page"}},"title":"list_data_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}}}}