{"openapi":"3.1.0","info":{"title":"Convex (BYOK) API","version":"0.1.0","description":"Convex (BYOK) lets an AI assistant read your own Convex data through the Convex API with a key you supply (Convex team access token). Read-only: 10 tools (get_token_details, list_projects, get_project, get_project_by_slug, list_project_deployments, list_team_deployments, get_deployment, list_deployment_classes, list_deployment_regions, list_custom_domains). The BYOK key travels with each request,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-convex.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-convex/docs"},"termsOfService":"https://connectorbay.com/byok-convex/terms"},"servers":[{"url":"https://byok-convex.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-convex/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_token_details":{"post":{"operationId":"get_token_details","summary":"Show which team and token the key belongs to: token id, team id, name, creation time and type. Use for \"Which Convex tea","description":"Show which team and token the key belongs to: token id, team id, name, creation time and type. Use for \"Which Convex team is my access token for\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_token_detailsArguments","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 a team's projects (highest id first) with slug, creation time and production and development deployment names; page","description":"List a team's projects (highest id first) with slug, creation time and production and development deployment names; paged by cursor. Use for \"What Convex projects does team 41 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Numeric Convex team id (shown in the dashboard where team access tokens are created).","maxLength":200,"title":"Team Id","type":"string"},"q":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Filter projects by name or slug text.","title":"Q"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Projects per page (default set by Convex).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"The nextCursor value of the previous page.","title":"Cursor"}},"required":["team_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/get_project":{"post":{"operationId":"get_project","summary":"Get one project by numeric id: name, slug, team and its deployment names. Use for \"Show Convex project 1042\".","description":"Get one project by numeric id: name, slug, team and its deployment names. Use for \"Show Convex project 1042\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Numeric Convex project id (list_projects returns it).","maxLength":200,"title":"Project Id","type":"string"}},"required":["project_id"],"title":"get_projectArguments","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_project_by_slug":{"post":{"operationId":"get_project_by_slug","summary":"Get one project by team slug (or id) and project slug. Use for \"Look up the Convex project support-bot in team acme\".","description":"Get one project by team slug (or id) and project slug. Use for \"Look up the Convex project support-bot in team acme\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id_or_slug":{"description":"Team slug or numeric id.","maxLength":200,"title":"Team Id Or Slug","type":"string"},"project_slug":{"description":"Project slug.","maxLength":200,"title":"Project Slug","type":"string"}},"required":["team_id_or_slug","project_slug"],"title":"get_project_by_slugArguments","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_project_deployments":{"post":{"operationId":"list_project_deployments","summary":"List a project's deployments with type (dev, prod, preview, custom), region, URL, class and last deploy time. Use for \"W","description":"List a project's deployments with type (dev, prod, preview, custom), region, URL, class and last deploy time. Use for \"Which deployments does Convex project 1042 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Numeric Convex project id (list_projects returns it).","maxLength":200,"title":"Project Id","type":"string"},"deployment_type":{"anyOf":[{"enum":["dev","prod","preview","custom"],"type":"string"},{"type":"null"}],"default":null,"description":"Only deployments of this type.","title":"Deployment Type"},"is_default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to list only default deployments.","title":"Is Default"},"include_local":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to include local deployments.","title":"Include Local"}},"required":["project_id"],"title":"list_project_deploymentsArguments","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_team_deployments":{"post":{"operationId":"list_team_deployments","summary":"List all deployments of a team, sortable and filterable by project, type or text; paged by cursor. Use for \"Which Convex","description":"List all deployments of a team, sortable and filterable by project, type or text; paged by cursor. Use for \"Which Convex deployments does team 41 run\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Numeric Convex team id (shown in the dashboard where team access tokens are created).","maxLength":200,"title":"Team Id","type":"string"},"project_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only deployments of this numeric project id.","title":"Project Id"},"deployment_type":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only deployments of this type, for example prod.","title":"Deployment Type"},"q":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Filter by name text.","title":"Q"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Deployments per page.","title":"Limit"},"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"The nextCursor value of the previous page.","title":"Cursor"}},"required":["team_id"],"title":"list_team_deploymentsArguments","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_deployment":{"post":{"operationId":"get_deployment","summary":"Get one cloud deployment by name: type, region, class, URL and last deploy time. Use for \"Show details of Convex deploym","description":"Get one cloud deployment by name: type, region, class, URL and last deploy time. Use for \"Show details of Convex deployment happy-animal-123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment_name":{"description":"Deployment name such as 'happy-animal-123'.","maxLength":200,"title":"Deployment Name","type":"string"}},"required":["deployment_name"],"title":"get_deploymentArguments","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_deployment_classes":{"post":{"operationId":"list_deployment_classes","summary":"List the deployment classes (machine sizes) available to a team and whether each can be used. Use for \"Which Convex depl","description":"List the deployment classes (machine sizes) available to a team and whether each can be used. Use for \"Which Convex deployment classes can team 41 use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Numeric Convex team id (shown in the dashboard where team access tokens are created).","maxLength":200,"title":"Team Id","type":"string"}},"required":["team_id"],"title":"list_deployment_classesArguments","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_deployment_regions":{"post":{"operationId":"list_deployment_regions","summary":"List the regions where a team can create deployments, with display names and availability. Use for \"In which regions can","description":"List the regions where a team can create deployments, with display names and availability. Use for \"In which regions can team 41 create Convex deployments\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Numeric Convex team id (shown in the dashboard where team access tokens are created).","maxLength":200,"title":"Team Id","type":"string"}},"required":["team_id"],"title":"list_deployment_regionsArguments","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_custom_domains":{"post":{"operationId":"list_custom_domains","summary":"List the custom domains configured for a deployment with verification time and what each domain points to. Use for \"Whic","description":"List the custom domains configured for a deployment with verification time and what each domain points to. Use for \"Which custom domains does Convex deployment happy-animal-123 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment_name":{"description":"Deployment name such as 'happy-animal-123'.","maxLength":200,"title":"Deployment Name","type":"string"}},"required":["deployment_name"],"title":"list_custom_domainsArguments","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}}}}