{"openapi":"3.1.0","info":{"title":"Xata (BYOK) API","version":"0.1.0","description":"Xata (BYOK) lets an AI assistant read your own Xata data through the Xata API with a key you supply (Xata API key). Read-only: 9 tools (list_organizations, get_organization, get_organization_limits, list_regions, list_projects, get_project, list_branches, get_branch, get_branch_logs). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-xata.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-xata/docs"},"termsOfService":"https://connectorbay.com/byok-xata/terms"},"servers":[{"url":"https://byok-xata.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-xata/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 Xata organizations the key can see with ID, name and account status (enabled or disabled, billing status, usage","description":"List the Xata organizations the key can see with ID, name and account status (enabled or disabled, billing status, usage tier). Use for \"Which Xata 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/get_organization":{"post":{"operationId":"get_organization","summary":"Get one Xata organization: name and status including billing status and usage tier. Use for \"Is my Xata organization in ","description":"Get one Xata organization: name and status including billing status and usage tier. Use for \"Is my Xata organization in good standing\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Xata organization ID; list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"}},"required":["organization_id"],"title":"get_organizationArguments","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_organization_limits":{"post":{"operationId":"get_organization_limits","summary":"Get the effective limits of a Xata organization: maximum projects, branches, instances per branch, storage per branch an","description":"Get the effective limits of a Xata organization: maximum projects, branches, instances per branch, storage per branch and creation rates. Use for \"What are my Xata plan limits\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Xata organization ID; list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"}},"required":["organization_id"],"title":"get_organization_limitsArguments","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_regions":{"post":{"operationId":"list_regions","summary":"List the regions where new Xata branches can be deployed for an organization, with cloud provider and whether public acc","description":"List the regions where new Xata branches can be deployed for an organization, with cloud provider and whether public access and backups are available. Use for \"Which regions can I deploy Xata branches in\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Xata organization ID; list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"}},"required":["organization_id"],"title":"list_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_projects":{"post":{"operationId":"list_projects","summary":"List the projects of a Xata organization with name, creation and update time and scale-to-zero and IP filtering settings","description":"List the projects of a Xata organization with name, creation and update time and scale-to-zero and IP filtering settings. Use for \"What Xata projects do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Xata organization ID; list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"}},"required":["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/get_project":{"post":{"operationId":"get_project","summary":"Get one Xata project: name, timestamps, scale-to-zero settings and IP filtering. Use for \"Show the settings of my Xata p","description":"Get one Xata project: name, timestamps, scale-to-zero settings and IP filtering. Use for \"Show the settings of my Xata project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Xata organization ID; list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"},"project_id":{"description":"Xata project ID; list_projects returns it.","maxLength":200,"title":"Project Id","type":"string"}},"required":["organization_id","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/list_branches":{"post":{"operationId":"list_branches","summary":"List the database branches of a Xata project with name, description, parent branch, region and public access and backup ","description":"List the database branches of a Xata project with name, description, parent branch, region and public access and backup flags. Use for \"What database branches does my Xata project have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Xata organization ID; list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"},"project_id":{"description":"Xata project ID; list_projects returns it.","maxLength":200,"title":"Project Id","type":"string"}},"required":["organization_id","project_id"],"title":"list_branchesArguments","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_branch":{"post":{"operationId":"get_branch","summary":"Get one Xata branch: lifecycle state, health, instance counts, region, instance type, storage, replicas, scale-to-zero a","description":"Get one Xata branch: lifecycle state, health, instance counts, region, instance type, storage, replicas, scale-to-zero and backup settings. Credentials are not read. Use for \"Is my Xata production branch healthy and how is it sized\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Xata organization ID; list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"},"project_id":{"description":"Xata project ID; list_projects returns it.","maxLength":200,"title":"Project Id","type":"string"},"branch_id":{"description":"Xata branch ID; list_branches returns it.","maxLength":200,"title":"Branch Id","type":"string"}},"required":["organization_id","project_id","branch_id"],"title":"get_branchArguments","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_branch_logs":{"post":{"operationId":"get_branch_logs","summary":"Get PostgreSQL log entries of a Xata branch between two times, newest page first, with level, process and message. Needs","description":"Get PostgreSQL log entries of a Xata branch between two times, newest page first, with level, process and message. Needs the logs:read scope. Use for \"Show errors in my Xata branch logs from the last hour\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Xata organization ID; list_organizations returns it.","maxLength":200,"title":"Organization Id","type":"string"},"project_id":{"description":"Xata project ID; list_projects returns it.","maxLength":200,"title":"Project Id","type":"string"},"branch_id":{"description":"Xata branch ID; list_branches returns it.","maxLength":200,"title":"Branch Id","type":"string"},"start":{"description":"Start time, ISO 8601 date-time, for example 2026-10-16T09:00:00Z.","maxLength":200,"title":"Start","type":"string"},"end":{"description":"End time, ISO 8601 date-time.","maxLength":200,"title":"End","type":"string"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many log entries to return (1 to 200).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor from the previous answer's nextCursor.","title":"Cursor"}},"required":["organization_id","project_id","branch_id","start","end"],"title":"get_branch_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}}}}