{"openapi":"3.1.0","info":{"title":"akenza (BYOK) API","version":"0.1.0","description":"akenza (BYOK) lets an AI assistant read your own akenza data through the akenza API with a key you supply (akenza API key). Read-only: 10 tools (get_organization, list_workspaces, list_devices, get_device, get_latest_sample, query_device_data, list_data_flows, list_device_connectors, list_tags, list_rules). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-akenza.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-akenza/docs"},"termsOfService":"https://connectorbay.com/byok-akenza/terms"},"servers":[{"url":"https://byok-akenza.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-akenza/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_organization":{"post":{"operationId":"get_organization","summary":"Get one akenza organization by id: name and settings. Use for \"Show my akenza organization details\".","description":"Get one akenza organization by id: name and settings. Use for \"Show my akenza organization details\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Organization id. Find it in the akenza console or in the id fields of workspaces.","maxLength":40,"title":"Organization Id","type":"string"}},"required":["organization_id"],"title":"get_organizationArguments","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_workspaces":{"post":{"operationId":"list_workspaces","summary":"List the workspaces of an akenza organization with name, description and creation time. Use for \"Which akenza workspaces","description":"List the workspaces of an akenza organization with name, description and creation time. Use for \"Which akenza workspaces do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Organization id whose workspaces to list.","maxLength":40,"title":"Organization Id","type":"string"},"page":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Page size (default 20, at most 100).","title":"Size"}},"required":["organization_id"],"title":"list_workspacesArguments","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_devices":{"post":{"operationId":"list_devices","summary":"List the devices (assets) of an akenza organization with connectivity, online state, tags and data flow. Optional text s","description":"List the devices (assets) of an akenza organization with connectivity, online state, tags and data flow. Optional text search. Use for \"Which devices are online in my akenza organization\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Organization id to list devices of.","maxLength":40,"title":"Organization Id","type":"string"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to search in device names and ids.","title":"Search"},"page":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Page size (default 20, at most 100).","title":"Size"}},"required":["organization_id"],"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 the details of one akenza device by its akenza id: name, connectivity, online timeout, tags and data flow. Use for \"","description":"Get the details of one akenza device by its akenza id: name, connectivity, online timeout, tags and data flow. Use for \"Show the details of akenza device 02d2327fedce2128\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"device_id":{"description":"akenza device id (the internal id, not the physical device EUI), as returned by list_devices.","maxLength":40,"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_sample":{"post":{"operationId":"get_latest_sample","summary":"Get the most recent data sample a device sent: topic, timestamp and decoded data. Use for \"What was the latest reading f","description":"Get the most recent data sample a device sent: topic, timestamp and decoded data. Use for \"What was the latest reading from akenza device 02d2327fedce2128\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"device_id":{"description":"akenza device id (the internal id, not the physical device EUI), as returned by list_devices.","maxLength":40,"title":"Device Id","type":"string"}},"required":["device_id"],"title":"get_latest_sampleArguments","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/query_device_data":{"post":{"operationId":"query_device_data","summary":"Query the raw stored data of a device, newest first, optionally for one topic and a time range. Use for \"Show the last 2","description":"Query the raw stored data of a device, newest first, optionally for one topic and a time range. Use for \"Show the last 20 readings of akenza device 02d2327fedce2128\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"device_id":{"description":"akenza device id (the internal id, not the physical device EUI), as returned by list_devices.","maxLength":40,"title":"Device Id","type":"string"},"topic":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":"*","description":"Data topic to read, for example lifecycle or event; * returns all topics.","title":"Topic"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many samples to return (default 100).","title":"Limit"},"skip":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many samples to skip, for paging.","title":"Skip"},"timestamp_after":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only samples after this ISO 8601 time, for example 2026-01-01T00:00:00Z.","title":"Timestamp After"},"timestamp_before":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only samples before this ISO 8601 time.","title":"Timestamp Before"}},"required":["device_id"],"title":"query_device_dataArguments","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_flows":{"post":{"operationId":"list_data_flows","summary":"List the data flows of a workspace (device connector to output connector pipelines) with their names. Use for \"Which dat","description":"List the data flows of a workspace (device connector to output connector pipelines) with their names. Use for \"Which data flows exist in my akenza workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id as returned by list_workspaces.","maxLength":40,"title":"Workspace Id","type":"string"},"page":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Page size (default 20, at most 100).","title":"Size"}},"required":["workspace_id"],"title":"list_data_flowsArguments","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_connectors":{"post":{"operationId":"list_device_connectors","summary":"List the device connectors of a workspace with connectivity type, carrier and provider. Secrets are not returned. Use fo","description":"List the device connectors of a workspace with connectivity type, carrier and provider. Secrets are not returned. Use for \"Which device connectors are set up in my akenza workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id as returned by list_workspaces.","maxLength":40,"title":"Workspace Id","type":"string"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Page size (default 20, at most 100).","title":"Size"}},"required":["workspace_id"],"title":"list_device_connectorsArguments","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_tags":{"post":{"operationId":"list_tags","summary":"List the device tags of a workspace. Use for \"Which tags do I use on my akenza devices\".","description":"List the device tags of a workspace. Use for \"Which tags do I use on my akenza devices\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id as returned by list_workspaces.","maxLength":40,"title":"Workspace Id","type":"string"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Page size (default 20, at most 100).","title":"Size"}},"required":["workspace_id"],"title":"list_tagsArguments","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_rules":{"post":{"operationId":"list_rules","summary":"List the rules of a workspace with their name, description and inputs. Use for \"Which rules are defined in my akenza wor","description":"List the rules of a workspace with their name, description and inputs. Use for \"Which rules are defined in my akenza workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id as returned by list_workspaces.","maxLength":40,"title":"Workspace Id","type":"string"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Page size (default 20, at most 100).","title":"Size"}},"required":["workspace_id"],"title":"list_rulesArguments","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}}}}