{"openapi":"3.1.0","info":{"title":"Squad (BYOK) API","version":"0.1.0","description":"Squad (BYOK) lets an AI assistant read your own Squad data through the Squad API with a key you supply (Squad secret key (starts with sk_ or sandbox_sk_)). Read-only: 5 tools (verify_transaction, get_ledger_balance, list_data_bundles, list_electricity_providers, list_sms_campaigns). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-squad.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-squad/docs"},"termsOfService":"https://connectorbay.com/byok-squad/terms"},"servers":[{"url":"https://byok-squad.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-squad/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/verify_transaction":{"post":{"operationId":"verify_transaction","summary":"Check the status of one Squad transaction by its reference: amount, currency, status (Success, Failed, Abandoned, Pendin","description":"Check the status of one Squad transaction by its reference: amount, currency, status (Success, Failed, Abandoned, Pending), type and creation time (payer and merchant emails are not returned). Use for \"Did Squad transaction SQCHIZ3634573076082 succeed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"transaction_ref":{"description":"Unique transaction reference of the transaction.","maxLength":200,"title":"Transaction Ref","type":"string"}},"required":["transaction_ref"],"title":"verify_transactionArguments","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_ledger_balance":{"post":{"operationId":"get_ledger_balance","summary":"Get your Squad wallet ledger balance in kobo (Naira only). Use for \"What is my Squad wallet balance\".","description":"Get your Squad wallet ledger balance in kobo (Naira only). Use for \"What is my Squad wallet balance\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"currency_id":{"const":"NGN","description":"Currency of the balance; Squad only accepts NGN.","title":"Currency Id","type":"string"}},"required":["currency_id"],"title":"get_ledger_balanceArguments","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_bundles":{"post":{"operationId":"list_data_bundles","summary":"List the mobile data bundle plans (name, size, validity, price, plan code) sold through Squad for one Nigerian network. ","description":"List the mobile data bundle plans (name, size, validity, price, plan code) sold through Squad for one Nigerian network. Use for \"Which MTN data bundles can I vend through Squad\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"network":{"description":"Telco id: MTN, GLO, AIRTEL or 9MOBILE.","enum":["MTN","GLO","AIRTEL","9MOBILE"],"title":"Network","type":"string"}},"required":["network"],"title":"list_data_bundlesArguments","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_electricity_providers":{"post":{"operationId":"list_electricity_providers","summary":"List the electricity distribution companies (code and name) available for Squad utility vending. Use for \"Which electric","description":"List the electricity distribution companies (code and name) available for Squad utility vending. Use for \"Which electricity providers does Squad support\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_electricity_providersArguments","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_sms_campaigns":{"post":{"operationId":"list_sms_campaigns","summary":"List your Squad bulk SMS campaigns with name, template, contact bucket, total recipients and creation time. Use for \"Wha","description":"List your Squad bulk SMS campaigns with name, template, contact bucket, total recipients and creation time. Use for \"What SMS campaigns have I created on Squad\".","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":20,"description":"Rows per page.","title":"Per Page"},"status":{"anyOf":[{"enum":["pending","failed","success"],"type":"string"},{"type":"null"}],"default":null,"description":"Campaign status filter: pending, failed or success.","title":"Status"},"name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Filter by campaign name.","title":"Name"},"date_from":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start date filter.","title":"Date From"},"date_to":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End date filter.","title":"Date To"}},"title":"list_sms_campaignsArguments","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}}}}