{"openapi":"3.1.0","info":{"title":"LiveChat Configuration (BYOK) API","version":"0.1.0","description":"LiveChat Configuration (BYOK) lets an AI assistant read your own LiveChat Configuration data through the LiveChat Configuration API with a key you supply (LiveChat Account ID). Read-only: 7 tools (list_greetings, get_greeting, list_auto_accesses, get_group_routing_status, list_license_properties, get_license_webhooks_state, list_webhooks). 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-livechat-configuration.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-livechat-configuration/docs"},"termsOfService":"https://connectorbay.com/byok-livechat-configuration/terms"},"servers":[{"url":"https://byok-livechat-configuration.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-livechat-configuration/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_greetings":{"post":{"operationId":"list_greetings","summary":"List the greeting campaigns (targeted messages shown to website visitors): name, type, active flag, group, trigger rules","description":"List the greeting campaigns (targeted messages shown to website visitors): name, type, active flag, group, trigger rules and message text. Up to 100 per page. Use for \"Which greeting campaigns do we have configured in LiveChat\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many greetings to return (1 to 100, default 100).","title":"Limit"},"page_id":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"next_page_id from the previous answer, to get the next page; leave out for the first page.","title":"Page Id"}},"title":"list_greetingsArguments","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_greeting":{"post":{"operationId":"get_greeting","summary":"Get one greeting campaign by id: name, type, active flag and schedule, group, trigger rules and message text. Use for \"S","description":"Get one greeting campaign by id: name, type, active flag and schedule, group, trigger rules and message text. Use for \"Show LiveChat greeting 123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Id of the greeting (a number such as 123), taken from list_greetings.","maximum":2147483647,"minimum":0,"title":"Id","type":"integer"}},"required":["id"],"title":"get_greetingArguments","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_auto_accesses":{"post":{"operationId":"list_auto_accesses","summary":"List the auto-access rules in order: which chat groups receive visitors matching domain, page URL or country conditions.","description":"List the auto-access rules in order: which chat groups receive visitors matching domain, page URL or country conditions. Use for \"How does LiveChat route visitors to groups by domain or country\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_auto_accessesArguments","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_group_routing_status":{"post":{"operationId":"get_group_routing_status","summary":"Get a group (team) with its language and current routing status (online, offline or online for incoming chats), without ","description":"Get a group (team) with its language and current routing status (online, offline or online for incoming chats), without listing members. Use for \"Is LiveChat group 19 online right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Id of the group (0 is the default group).","maximum":2147483647,"minimum":0,"title":"Id","type":"integer"}},"required":["id"],"title":"get_group_routing_statusArguments","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_license_properties":{"post":{"operationId":"list_license_properties","summary":"List the key-value properties stored on the LiveChat license, grouped by namespace; optionally limit by namespace or nam","description":"List the key-value properties stored on the LiveChat license, grouped by namespace; optionally limit by namespace or name prefix. Use for \"What custom properties are stored on our LiveChat license\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"namespace":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Properties namespace (usually an application's Client ID); leave out for all you can read.","title":"Namespace"},"name_prefix":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only properties whose name starts with this text.","title":"Name Prefix"}},"title":"list_license_propertiesArguments","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_license_webhooks_state":{"post":{"operationId":"get_license_webhooks_state","summary":"Check whether the webhooks of one application are enabled on the LiveChat license. Use for \"Are webhooks enabled for my ","description":"Check whether the webhooks of one application are enabled on the LiveChat license. Use for \"Are webhooks enabled for my LiveChat app\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"owner_client_id":{"description":"Client ID (application ID) of the integration whose data you want; shown in the Text Developer Console under Apps. Must be owned by your organization.","maxLength":64,"title":"Owner Client Id","type":"string"}},"required":["owner_client_id"],"title":"get_license_webhooks_stateArguments","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_webhooks":{"post":{"operationId":"list_webhooks","summary":"List the webhooks registered for one application: target URL, description, event action and type. Use for \"Which LiveCha","description":"List the webhooks registered for one application: target URL, description, event action and type. Use for \"Which LiveChat webhooks does my app have registered\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"owner_client_id":{"description":"Client ID (application ID) of the integration whose data you want; shown in the Text Developer Console under Apps. Must be owned by your organization.","maxLength":64,"title":"Owner Client Id","type":"string"}},"required":["owner_client_id"],"title":"list_webhooksArguments","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}}}}