{"openapi":"3.1.0","info":{"title":"Gleap (BYOK) API","version":"0.1.0","description":"Gleap (BYOK) lets an AI assistant read your own Gleap data through the Gleap API with a key you supply (API key (Project Settings > Security)). Read-only: 8 tools (list_tickets, get_ticket, search_tickets, get_ticket_counts, list_help_collections, list_collection_articles, list_teams, get_article_stats). The BYOK key travels with each request, is used for that one call only and is never stored,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-gleap.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-gleap/docs"},"termsOfService":"https://connectorbay.com/byok-gleap/terms"},"servers":[{"url":"https://byok-gleap.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-gleap/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_tickets":{"post":{"operationId":"list_tickets","summary":"List tickets (bugs, feature requests, inquiries, AI bot conversations), most recent activity first, filtered by type, st","description":"List tickets (bugs, feature requests, inquiries, AI bot conversations), most recent activity first, filtered by type, status or priority. Up to 500 per call; page with skip. Use for \"What high-priority bugs are open in Gleap\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Ticket type or comma-separated types, for example BUG or BUG,FEATURE_REQUEST.","title":"Type"},"status":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Status such as OPEN.","title":"Status"},"priority":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Priority key or comma-separated keys: LOW, MEDIUM, HIGH or a custom key.","title":"Priority"},"sort":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Order: -createdAt (newest first), createdAt, -updatedAt, priority or -priority.","title":"Sort"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many tickets to return (1 to 500).","title":"Limit"},"skip":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many tickets to skip, for paging.","title":"Skip"}},"title":"list_ticketsArguments","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_ticket":{"post":{"operationId":"get_ticket","summary":"Get one ticket by id with its form data, type, status, priority, assignee and timestamps. Use for \"Show me Gleap ticket ","description":"Get one ticket by id with its form data, type, status, priority, assignee and timestamps. Use for \"Show me Gleap ticket 507f1f77bcf86cd799439011\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ticket_id":{"description":"Ticket id, taken from list_tickets.","maxLength":40,"title":"Ticket Id","type":"string"}},"required":["ticket_id"],"title":"get_ticketArguments","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/search_tickets":{"post":{"operationId":"search_tickets","summary":"Full-text search over tickets and their comments, at most 30 hits ordered by relevance. Use for \"Find Gleap tickets that","description":"Full-text search over tickets and their comments, at most 30 hits ordered by relevance. Use for \"Find Gleap tickets that mention checkout errors\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search_term":{"description":"Text to look for (up to 100 characters).","maxLength":100,"title":"Search Term","type":"string"},"type":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only this ticket type, for example BUG.","title":"Type"},"status":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only this status, for example OPEN.","title":"Status"},"archived":{"anyOf":[{"enum":["true","false"],"type":"string"},{"type":"null"}],"default":null,"description":"true for archived tickets only, false for active only; leave empty to search both.","title":"Archived"}},"required":["search_term"],"title":"search_ticketsArguments","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_ticket_counts":{"post":{"operationId":"get_ticket_counts","summary":"Count tickets per status (archived, hidden, spam and merged tickets are excluded); optionally limited to one ticket type","description":"Count tickets per status (archived, hidden, spam and merged tickets are excluded); optionally limited to one ticket type. Use for \"How many Gleap tickets are in each status\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only count this ticket type, for example BUG.","title":"Type"}},"title":"get_ticket_countsArguments","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_help_collections":{"post":{"operationId":"list_help_collections","summary":"List help center collections (top level by default) with description, audience, article count and sub-collection count. ","description":"List help center collections (top level by default) with description, audience, article count and sub-collection count. Use for \"What help center collections exist in Gleap\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"parent_id":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Collection id to list the children of, or 'all' for every collection; empty for top-level collections.","title":"Parent Id"}},"title":"list_help_collectionsArguments","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_collection_articles":{"post":{"operationId":"list_collection_articles","summary":"List every article of one help center collection, published and draft, with title, tags and draft flag. Use for \"Which a","description":"List every article of one help center collection, published and draft, with title, tags and draft flag. Use for \"Which articles are in Gleap help collection 507f1f77bcf86cd799439011\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"collection_id":{"description":"Collection id, taken from list_help_collections.","maxLength":40,"title":"Collection Id","type":"string"}},"required":["collection_id"],"title":"list_collection_articlesArguments","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_teams":{"post":{"operationId":"list_teams","summary":"List the support teams with members, assignment method, ticket limits and opening hours. Use for \"Which support teams do","description":"List the support teams with members, assignment method, ticket limits and opening hours. Use for \"Which support teams does our Gleap project have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_teamsArguments","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_article_stats":{"post":{"operationId":"get_article_stats","summary":"Count the live and draft help center articles of the project. Use for \"How many help articles are live in Gleap\".","description":"Count the live and draft help center articles of the project. Use for \"How many help articles are live in Gleap\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_article_statsArguments","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}}}}