{"openapi":"3.1.0","info":{"title":"Golioth (BYOK) API","version":"0.1.0","description":"Golioth (BYOK) lets an AI assistant read your own Golioth data through the Golioth API with a key you supply (Golioth project API key). Read-only: 12 tools (list_organizations, list_projects, list_devices, get_device, list_device_activity, list_logs, list_releases, list_artifacts, list_blueprints, list_tags, list_cohorts, list_ota_events). The BYOK key travels with each request, is used for that...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-golioth.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-golioth/docs"},"termsOfService":"https://connectorbay.com/byok-golioth/terms"},"servers":[{"url":"https://byok-golioth.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-golioth/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_organizations":{"post":{"operationId":"list_organizations","summary":"List the Golioth organizations the key can see with name, tier and payment status. Use for \"Which Golioth organizations ","description":"List the Golioth organizations the key can see with name, tier and payment status. Use for \"Which Golioth organizations do I belong to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_organizationsArguments","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 the Golioth projects the key can see with name, organization and roles. Use for \"Which Golioth projects do I have\".","description":"List the Golioth projects the key can see with name, organization and roles. Use for \"Which Golioth projects do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only projects of this organization id.","title":"Organization Id"}},"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_devices":{"post":{"operationId":"list_devices","summary":"List the devices in a project with status, enabled flag, hardware ids, tags, blueprint and last report time. Use for \"Wh","description":"List the devices in a project with status, enabled flag, hardware ids, tags, blueprint and last report time. Use for \"Which Golioth devices have not reported recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Golioth project id as returned by list_projects.","maxLength":200,"title":"Project Id","type":"string"},"term":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Partial text to match against device names or hardware ids.","title":"Term"},"device_name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only the device with this exact name.","title":"Device Name"},"hardware_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only the device with this exact hardware id.","title":"Hardware Id"},"blueprint_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only devices of this blueprint id.","title":"Blueprint Id"},"cohort_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only devices in this cohort id.","title":"Cohort Id"},"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for enabled devices only, false for disabled only.","title":"Enabled"},"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":50,"description":"How many items per page (1 to 100).","title":"Per Page"}},"required":["project_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 one device with status, last report, last seen online and offline times, tags and cohort. Use for \"When was Golioth ","description":"Get one device with status, last report, last seen online and offline times, tags and cohort. Use for \"When was Golioth device dev-123 last online\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Golioth project id as returned by list_projects.","maxLength":200,"title":"Project Id","type":"string"},"device_id":{"description":"Device id as returned by list_devices.","maxLength":200,"title":"Device Id","type":"string"}},"required":["project_id","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/list_device_activity":{"post":{"operationId":"list_device_activity","summary":"List per-device activity: status, last report and last seen online and offline times. Use for \"Which Golioth devices wen","description":"List per-device activity: status, last report and last seen online and offline times. Use for \"Which Golioth devices went offline most recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Golioth project id as returned by list_projects.","maxLength":200,"title":"Project Id","type":"string"},"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":50,"description":"How many items per page (1 to 100).","title":"Per Page"}},"required":["project_id"],"title":"list_device_activityArguments","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_logs":{"post":{"operationId":"list_logs","summary":"List device log lines from a project, filtered by device, level, module, text and time range. Use for \"Show Golioth ERRO","description":"List device log lines from a project, filtered by device, level, module, text and time range. Use for \"Show Golioth ERROR logs from device dev-123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Golioth project id as returned by list_projects.","maxLength":200,"title":"Project Id","type":"string"},"device_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only logs of this device id.","title":"Device Id"},"level":{"anyOf":[{"enum":["NONE","DEBUG","INFO","WARN","ERROR"],"type":"string"},{"type":"null"}],"default":"NONE","description":"Minimum level: NONE, DEBUG, INFO, WARN or ERROR.","title":"Level"},"module":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only logs from this module name.","title":"Module"},"term":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only logs whose message contains this text.","title":"Term"},"start":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only logs after this ISO 8601 time.","title":"Start"},"end":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only logs before this ISO 8601 time.","title":"End"}},"required":["project_id"],"title":"list_logsArguments","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_releases":{"post":{"operationId":"list_releases","summary":"List firmware releases with sequence number, tags, rollout flag and artifact ids. Use for \"Which firmware releases are r","description":"List firmware releases with sequence number, tags, rollout flag and artifact ids. Use for \"Which firmware releases are rolled out in Golioth\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Golioth project id as returned by list_projects.","maxLength":200,"title":"Project Id","type":"string"},"rollout":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to list only releases that are rolling out.","title":"Rollout"},"blueprint_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only releases of this blueprint id.","title":"Blueprint Id"},"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":50,"description":"How many items per page (1 to 100).","title":"Per Page"}},"required":["project_id"],"title":"list_releasesArguments","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_artifacts":{"post":{"operationId":"list_artifacts","summary":"List uploaded firmware artifacts with package, version, size and blueprint. Use for \"What firmware artifact versions are","description":"List uploaded firmware artifacts with package, version, size and blueprint. Use for \"What firmware artifact versions are uploaded to Golioth\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Golioth project id as returned by list_projects.","maxLength":200,"title":"Project Id","type":"string"},"package":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only artifacts of this package name.","title":"Package"},"version":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only artifacts of this version.","title":"Version"},"blueprint_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only artifacts of this blueprint id.","title":"Blueprint Id"},"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":50,"description":"How many items per page (1 to 100).","title":"Per Page"}},"required":["project_id"],"title":"list_artifactsArguments","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_blueprints":{"post":{"operationId":"list_blueprints","summary":"List device blueprints with name, board and platform. Use for \"Which device blueprints exist in my Golioth project\".","description":"List device blueprints with name, board and platform. Use for \"Which device blueprints exist in my Golioth project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Golioth project id as returned by list_projects.","maxLength":200,"title":"Project Id","type":"string"},"blueprint_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only blueprints with this name.","title":"Blueprint Name"},"platform":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only blueprints for this platform.","title":"Platform"},"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":50,"description":"How many items per page (1 to 100).","title":"Per Page"}},"required":["project_id"],"title":"list_blueprintsArguments","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 defined in a project. Use for \"What device tags are defined in Golioth\".","description":"List the device tags defined in a project. Use for \"What device tags are defined in Golioth\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Golioth project id as returned by list_projects.","maxLength":200,"title":"Project Id","type":"string"},"tag_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only the tag with this name.","title":"Tag Name"},"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":50,"description":"How many items per page (1 to 100).","title":"Per Page"}},"required":["project_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_cohorts":{"post":{"operationId":"list_cohorts","summary":"List cohorts (device groups for staged updates) with device count and active deployment. Use for \"How many devices are i","description":"List cohorts (device groups for staged updates) with device count and active deployment. Use for \"How many devices are in each Golioth cohort\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Golioth organization id as returned by list_organizations.","maxLength":200,"title":"Organization Id","type":"string"},"project_id":{"description":"Golioth project id as returned by list_projects.","maxLength":200,"title":"Project Id","type":"string"},"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":50,"description":"How many items per page (1 to 100).","title":"Per Page"}},"required":["organization_id","project_id"],"title":"list_cohortsArguments","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_ota_events":{"post":{"operationId":"list_ota_events","summary":"List over-the-air update events with device, event type, status code, current and target version. Use for \"Which Golioth","description":"List over-the-air update events with device, event type, status code, current and target version. Use for \"Which Golioth devices failed their last OTA update\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Golioth organization id as returned by list_organizations.","maxLength":200,"title":"Organization Id","type":"string"},"project_id":{"description":"Golioth project id as returned by list_projects.","maxLength":200,"title":"Project Id","type":"string"},"device_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only events of this device id.","title":"Device Id"},"cohort_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only events of this cohort id.","title":"Cohort Id"},"event_type":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only this event type.","title":"Event Type"},"start_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only events after this ISO 8601 time.","title":"Start Time"},"end_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only events before this ISO 8601 time; leave out for everything up to now.","title":"End Time"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many events to return (1 to 100).","title":"Limit"},"page_token":{"anyOf":[{"maxLength":2000,"type":"string"},{"type":"null"}],"default":null,"description":"Token from the previous answer's nextPageToken for the next page.","title":"Page Token"}},"required":["organization_id","project_id"],"title":"list_ota_eventsArguments","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}}}}