{"openapi":"3.1.0","info":{"title":"Kintone (BYOK) API","version":"0.1.0","description":"Kintone (BYOK) lets an AI assistant read your own Kintone data through the Kintone API with a key you supply (app API token (one app; needs the View records permission)). Read-only: 7 tools (get_app, get_form_fields, get_views, get_process_management, get_general_settings, get_record, get_records). The BYOK key travels with each request, is used for that one call only and is never stored, logged...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-kintone.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-kintone/docs"},"termsOfService":"https://connectorbay.com/byok-kintone/terms"},"servers":[{"url":"https://byok-kintone.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-kintone/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_app":{"post":{"operationId":"get_app","summary":"Get basic information about one app: id, code, name, description, space and thread ids, creator, creation and last-modif","description":"Get basic information about one app: id, code, name, description, space and thread ids, creator, creation and last-modified times. Use for \"What is kintone app 1 called and who created it\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your kintone subdomain, the part before .cybozu.com (for example 'acme' for acme.cybozu.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"app":{"description":"Numeric app id (shown in the app's address as /k/<id>/).","minimum":1,"title":"App","type":"integer"}},"required":["subdomain","app"],"title":"get_appArguments","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_form_fields":{"post":{"operationId":"get_form_fields","summary":"Get the field definitions of an app (field codes, types, labels and options) as a map keyed by field code. Use it to lea","description":"Get the field definitions of an app (field codes, types, labels and options) as a map keyed by field code. Use it to learn the codes before querying records. Use for \"What fields does kintone app 1 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your kintone subdomain, the part before .cybozu.com (for example 'acme' for acme.cybozu.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"app":{"description":"Numeric app id (shown in the app's address as /k/<id>/).","minimum":1,"title":"App","type":"integer"},"lang":{"anyOf":[{"enum":["default","en","zh","ja","user"],"type":"string"},{"type":"null"}],"default":null,"description":"Language of the labels: default, en, zh, ja or user.","title":"Lang"}},"required":["subdomain","app"],"title":"get_form_fieldsArguments","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_views":{"post":{"operationId":"get_views","summary":"Get the list views of an app with each view's type, name, id, displayed fields, filter and sort. Use for \"Which views do","description":"Get the list views of an app with each view's type, name, id, displayed fields, filter and sort. Use for \"Which views does kintone app 1 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your kintone subdomain, the part before .cybozu.com (for example 'acme' for acme.cybozu.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"app":{"description":"Numeric app id (shown in the app's address as /k/<id>/).","minimum":1,"title":"App","type":"integer"},"lang":{"anyOf":[{"enum":["default","en","zh","ja","user"],"type":"string"},{"type":"null"}],"default":null,"description":"Language of the names: default, en, zh, ja or user.","title":"Lang"}},"required":["subdomain","app"],"title":"get_viewsArguments","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_process_management":{"post":{"operationId":"get_process_management","summary":"Get the process management (workflow) settings of an app: whether enabled, the statuses with their assignee rules, and t","description":"Get the process management (workflow) settings of an app: whether enabled, the statuses with their assignee rules, and the actions between them. Use for \"What workflow statuses does kintone app 1 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your kintone subdomain, the part before .cybozu.com (for example 'acme' for acme.cybozu.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"app":{"description":"Numeric app id (shown in the app's address as /k/<id>/).","minimum":1,"title":"App","type":"integer"},"lang":{"anyOf":[{"enum":["default","en","zh","ja","user"],"type":"string"},{"type":"null"}],"default":null,"description":"Language of the names: default, en, zh, ja or user.","title":"Lang"}},"required":["subdomain","app"],"title":"get_process_managementArguments","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_general_settings":{"post":{"operationId":"get_general_settings","summary":"Get the general settings of an app: name, description, theme, record title field and which record features are switched ","description":"Get the general settings of an app: name, description, theme, record title field and which record features are switched on. Use for \"What are the general settings of kintone app 1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your kintone subdomain, the part before .cybozu.com (for example 'acme' for acme.cybozu.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"app":{"description":"Numeric app id (shown in the app's address as /k/<id>/).","minimum":1,"title":"App","type":"integer"},"lang":{"anyOf":[{"enum":["default","en","zh","ja","user"],"type":"string"},{"type":"null"}],"default":null,"description":"Language of the names: default, en, zh, ja or user.","title":"Lang"}},"required":["subdomain","app"],"title":"get_general_settingsArguments","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_record":{"post":{"operationId":"get_record","summary":"Get one record by id with every field the token can see, as field-code to {type, value} pairs. Use for \"Show record 100 ","description":"Get one record by id with every field the token can see, as field-code to {type, value} pairs. Use for \"Show record 100 of kintone app 1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your kintone subdomain, the part before .cybozu.com (for example 'acme' for acme.cybozu.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"app":{"description":"Numeric app id (shown in the app's address as /k/<id>/).","minimum":1,"title":"App","type":"integer"},"id":{"description":"Record id (the record number shown in the app).","minimum":1,"title":"Id","type":"integer"}},"required":["subdomain","app","id"],"title":"get_recordArguments","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_records":{"post":{"operationId":"get_records","summary":"Search records of an app with a kintone query (for example 'Status = \"Done\" order by $id desc limit 50 offset 0'); retur","description":"Search records of an app with a kintone query (for example 'Status = \"Done\" order by $id desc limit 50 offset 0'); returns up to 500 records of field-code to {type, value} pairs. Offset in the query is at most 10000. Use for \"Show the 20 newest records of kintone app 1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your kintone subdomain, the part before .cybozu.com (for example 'acme' for acme.cybozu.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"app":{"description":"Numeric app id (shown in the app's address as /k/<id>/).","minimum":1,"title":"App","type":"integer"},"query":{"anyOf":[{"maxLength":1000,"type":"string"},{"type":"null"}],"default":null,"description":"Kintone query string with conditions, order by, limit (maximum 500, default 100) and offset. Empty returns the first 100 records.","title":"Query"},"total_count":{"anyOf":[{"enum":["true","false"],"type":"string"},{"type":"null"}],"default":null,"description":"true to include the total number of matching records.","title":"Total Count"}},"required":["subdomain","app"],"title":"get_recordsArguments","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}}}}