{"openapi":"3.1.0","info":{"title":"Things Board Control (BYOK) API","version":"0.1.0","description":"Things Board Control (BYOK) lets an AI assistant read your own Things Board Control data through the Things Board Control API with a key you supply (ThingsBoard API key (thingsboard.cloud, ThingsBoard 4.3 or newer; EU accounts use eu.thingsboard.cloud)). Read-only: 6 tools (list_devices, get_device, get_latest_telemetry, get_device_attributes, get_rpc_request, list_device_rpc_requests). The BYOK...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-thingsboard-control.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-thingsboard-control/docs"},"termsOfService":"https://connectorbay.com/byok-thingsboard-control/terms"},"servers":[{"url":"https://byok-thingsboard-control.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-thingsboard-control/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_devices":{"post":{"operationId":"list_devices","summary":"List the tenant's devices with id, name, device type, label and creation time. Use it to find the device id for a comman","description":"List the tenant's devices with id, name, device type, label and creation time. Use it to find the device id for a command. Use for \"Which devices are in my ThingsBoard tenant\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"description":"How many entities per page (1 to 1000).","maximum":1000,"minimum":1,"title":"Page Size","type":"integer"},"page":{"description":"Page number, starting at 0.","maximum":100000,"minimum":0,"title":"Page","type":"integer"},"text_search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only entities whose name contains this text.","title":"Text Search"},"type":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only devices of this device type (profile name).","title":"Type"}},"required":["page_size","page"],"title":"list_devicesArguments","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_device":{"post":{"operationId":"get_device","summary":"Get one device by id: name, type, label and creation time. Use for \"Show the ThingsBoard device 784f394c-42b6-435a-983c-","description":"Get one device by id: name, type, label and creation time. Use for \"Show the ThingsBoard device 784f394c-42b6-435a-983c-b7beff2784f9\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"device_id":{"description":"Device id: the UUID shown as id.id by list_devices, for example '784f394c-42b6-435a-983c-b7beff2784f9'.","maxLength":60,"title":"Device Id","type":"string"}},"required":["device_id"],"title":"get_deviceArguments","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_latest_telemetry":{"post":{"operationId":"get_latest_telemetry","summary":"Get the most recent value and timestamp of the given telemetry keys of a device, to check the state after a command. Use","description":"Get the most recent value and timestamp of the given telemetry keys of a device, to check the state after a command. Use for \"What are the latest temperature and humidity values of ThingsBoard device 784f394c-42b6-435a-983c-b7beff2784f9\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"device_id":{"description":"Device id: the UUID shown as id.id by list_devices, for example '784f394c-42b6-435a-983c-b7beff2784f9'.","maxLength":60,"title":"Device Id","type":"string"},"keys":{"description":"Comma-separated telemetry key names, for example 'temperature,humidity'.","maxLength":300,"title":"Keys","type":"string"}},"required":["device_id","keys"],"title":"get_latest_telemetryArguments","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_device_attributes":{"post":{"operationId":"get_device_attributes","summary":"Read a device's attributes of one scope (server, shared or client) with key, value and last update time. Use for \"Which ","description":"Read a device's attributes of one scope (server, shared or client) with key, value and last update time. Use for \"Which shared attributes does ThingsBoard device 784f394c-42b6-435a-983c-b7beff2784f9 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"device_id":{"description":"Device id: the UUID shown as id.id by list_devices, for example '784f394c-42b6-435a-983c-b7beff2784f9'.","maxLength":60,"title":"Device Id","type":"string"},"scope":{"description":"Attribute scope: SERVER_SCOPE, SHARED_SCOPE or CLIENT_SCOPE.","enum":["SERVER_SCOPE","SHARED_SCOPE","CLIENT_SCOPE"],"title":"Scope","type":"string"},"keys":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated attribute keys to return; omit for all.","title":"Keys"}},"required":["device_id","scope"],"title":"get_device_attributesArguments","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_rpc_request":{"post":{"operationId":"get_rpc_request","summary":"Get the status and reply of one persistent RPC call by its rpcId (QUEUED, SENT, DELIVERED, SUCCESSFUL, TIMEOUT, EXPIRED ","description":"Get the status and reply of one persistent RPC call by its rpcId (QUEUED, SENT, DELIVERED, SUCCESSFUL, TIMEOUT, EXPIRED or FAILED). Use for \"What happened to ThingsBoard RPC call 11111111-2222-3333-4444-555555555555\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"rpc_id":{"description":"The rpcId returned when a persistent command was sent.","maxLength":60,"title":"Rpc Id","type":"string"}},"required":["rpc_id"],"title":"get_rpc_requestArguments","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_device_rpc_requests":{"post":{"operationId":"list_device_rpc_requests","summary":"List the persistent RPC calls sent to a device, newest first, with method, status and reply. Use for \"Which commands wer","description":"List the persistent RPC calls sent to a device, newest first, with method, status and reply. Use for \"Which commands were queued for ThingsBoard device 784f394c-42b6-435a-983c-b7beff2784f9\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"device_id":{"description":"Device id: the UUID shown as id.id by list_devices, for example '784f394c-42b6-435a-983c-b7beff2784f9'.","maxLength":60,"title":"Device Id","type":"string"},"page_size":{"description":"How many calls per page (1 to 100).","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"page":{"description":"Page number, starting at 0.","maximum":100000,"minimum":0,"title":"Page","type":"integer"},"rpc_status":{"anyOf":[{"enum":["QUEUED","SENT","DELIVERED","SUCCESSFUL","TIMEOUT","EXPIRED","FAILED"],"type":"string"},{"type":"null"}],"default":null,"description":"Only calls in this state.","title":"Rpc Status"},"sort_property":{"anyOf":[{"enum":["createdTime","expirationTime","request","response"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort by createdTime, expirationTime, request or response.","title":"Sort Property"},"sort_order":{"anyOf":[{"enum":["ASC","DESC"],"type":"string"},{"type":"null"}],"default":null,"description":"ASC or DESC.","title":"Sort Order"}},"required":["device_id","page_size","page"],"title":"list_device_rpc_requestsArguments","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}}}}