{"openapi":"3.1.0","info":{"title":"Gupshup (BYOK) API","version":"0.1.0","description":"Gupshup (BYOK) lets an AI assistant read your own Gupshup data through the Gupshup API with a key you supply (Gupshup account API key). Read-only: 5 tools (list_templates, get_template, get_business_details, get_profile_about, get_profile_photo). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.gupshup.io....\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-gupshup.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-gupshup/docs"},"termsOfService":"https://connectorbay.com/byok-gupshup/terms"},"servers":[{"url":"https://byok-gupshup.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-gupshup/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_templates":{"post":{"operationId":"list_templates","summary":"List the WhatsApp message templates of an app with name, category, type, language, approval status, quality rating and b","description":"List the WhatsApp message templates of an app with name, category, type, language, approval status, quality rating and body text; filter by status, category, type, quality or language. Pages start at 0. Use for \"Which of my Gupshup WhatsApp templates are approved\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"app_id":{"description":"Gupshup app id (a UUID shown on the app dashboard).","maxLength":200,"title":"App Id","type":"string"},"page_no":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page No"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"Templates per page (default 100).","title":"Page Size"},"template_status":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only templates with this status, for example APPROVED, PENDING or REJECTED.","title":"Template Status"},"template_category":{"anyOf":[{"enum":["MARKETING","UTILITY","AUTHENTICATION"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this category: MARKETING, UTILITY or AUTHENTICATION.","title":"Template Category"},"template_type":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only this template type, for example TEXT, IMAGE or VIDEO.","title":"Template Type"},"quality":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only this quality rating, for example GREEN, YELLOW or RED.","title":"Quality"},"language_code":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only this language code, for example en.","title":"Language Code"}},"required":["app_id"],"title":"list_templatesArguments","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_template":{"post":{"operationId":"get_template","summary":"Get one WhatsApp template by its Gupshup template id with category, type, language, approval status, quality and body te","description":"Get one WhatsApp template by its Gupshup template id with category, type, language, approval status, quality and body text. Use for \"Show Gupshup template 312781e9-2771-463b-8cfd-cdx64b810ccf\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"app_id":{"description":"Gupshup app id (a UUID shown on the app dashboard).","maxLength":200,"title":"App Id","type":"string"},"template_id":{"description":"Gupshup template id (the 'id' field from list_templates).","maxLength":200,"title":"Template Id","type":"string"}},"required":["app_id","template_id"],"title":"get_templateArguments","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_business_details":{"post":{"operationId":"get_business_details","summary":"Get the business record attached to an app: business name, industry vertical, website, country, state, city, HQ region a","description":"Get the business record attached to an app: business name, industry vertical, website, country, state, city, HQ region and creation time. Contact person, phone and email are not returned. Use for \"What business is attached to my Gupshup app\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"app_id":{"description":"Gupshup app id (a UUID shown on the app dashboard).","maxLength":200,"title":"App Id","type":"string"}},"required":["app_id"],"title":"get_business_detailsArguments","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_profile_about":{"post":{"operationId":"get_profile_about","summary":"Get the 'about' text of the WhatsApp business profile of an app. Use for \"What is the about text on my Gupshup WhatsApp ","description":"Get the 'about' text of the WhatsApp business profile of an app. Use for \"What is the about text on my Gupshup WhatsApp profile\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"app_id":{"description":"Gupshup app id (a UUID shown on the app dashboard).","maxLength":200,"title":"App Id","type":"string"}},"required":["app_id"],"title":"get_profile_aboutArguments","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_profile_photo":{"post":{"operationId":"get_profile_photo","summary":"Get the link to the WhatsApp business profile photo of an app. Use for \"What is the profile photo link of my Gupshup app","description":"Get the link to the WhatsApp business profile photo of an app. Use for \"What is the profile photo link of my Gupshup app\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"app_id":{"description":"Gupshup app id (a UUID shown on the app dashboard).","maxLength":200,"title":"App Id","type":"string"}},"required":["app_id"],"title":"get_profile_photoArguments","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}}}}