{"openapi":"3.1.0","info":{"title":"Airtable Base Admin (BYOK) API","version":"0.1.0","description":"Airtable Base Admin (BYOK) lets an AI assistant read your own Airtable Base Admin data through the Airtable Base Admin API with a key you supply (personal access token). Read-only: 5 tools (list_webhooks, list_shares, list_block_installations, get_view_metadata, get_enterprise_account). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached;...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-airtable-base-admin.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-airtable-base-admin/docs"},"termsOfService":"https://connectorbay.com/byok-airtable-base-admin/terms"},"servers":[{"url":"https://byok-airtable-base-admin.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-airtable-base-admin/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_webhooks":{"post":{"operationId":"list_webhooks","summary":"List the webhooks registered for a base with enabled flags, expiry, last notification result, next payload cursor and wh","description":"List the webhooks registered for a base with enabled flags, expiry, last notification result, next payload cursor and what each watches. The notification URL is not returned. Needs the webhook:manage scope. Use for \"Which Airtable webhooks are registered on my base appABCDEFGHIJKLMN\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"base_id":{"description":"Airtable base id, starting with 'app', for example 'appABCDEFGHIJKLMN'.","maxLength":200,"title":"Base Id","type":"string"}},"required":["base_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}},"/v1/tools/list_shares":{"post":{"operationId":"list_shares","summary":"List the shared links of a base (base, view or block shares) with state, type, view id, password-protection flag, domain","description":"List the shared links of a base (base, view or block shares) with state, type, view id, password-protection flag, domain restrictions and creation time. Share ids are cut to their 8-character prefix. Enterprise plans only; needs the shares:manage scope and editor role. Use for \"Which shared links does my Airtable base appABCDEFGHIJKLMN have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"base_id":{"description":"Airtable base id, starting with 'app', for example 'appABCDEFGHIJKLMN'.","maxLength":200,"title":"Base Id","type":"string"}},"required":["base_id"],"title":"list_sharesArguments","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_block_installations":{"post":{"operationId":"list_block_installations","summary":"List the blocks (extensions) installed in a base with block id, slug for Airtable-made blocks, state and creation time. ","description":"List the blocks (extensions) installed in a base with block id, slug for Airtable-made blocks, state and creation time. Use for \"Which extensions are installed in my Airtable base appABCDEFGHIJKLMN\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"base_id":{"description":"Airtable base id, starting with 'app', for example 'appABCDEFGHIJKLMN'.","maxLength":200,"title":"Base Id","type":"string"}},"required":["base_id"],"title":"list_block_installationsArguments","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_view_metadata":{"post":{"operationId":"get_view_metadata","summary":"Get one view's basic metadata: id, name, type (grid, form, calendar, gallery, kanban, timeline or block) and optionally ","description":"Get one view's basic metadata: id, name, type (grid, form, calendar, gallery, kanban, timeline or block) and optionally the visible field ids of a grid view. Use for \"Which fields are visible in view viwQpsuEDqHFqegkp of my Airtable base\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"base_id":{"description":"Airtable base id, starting with 'app', for example 'appABCDEFGHIJKLMN'.","maxLength":200,"title":"Base Id","type":"string"},"view_id":{"description":"Airtable view id, starting with 'viw', for example 'viwQpsuEDqHFqegkp'.","maxLength":200,"title":"View Id","type":"string"},"include_visible_fields":{"anyOf":[{"const":"visibleFieldIds","type":"string"},{"type":"null"}],"default":null,"description":"Set to visibleFieldIds to also return the visible field ids of a grid view.","title":"Include Visible Fields"}},"required":["base_id","view_id"],"title":"get_view_metadataArguments","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_enterprise_account":{"post":{"operationId":"get_enterprise_account","summary":"Get the structure of an enterprise account: creation time, root and descendant account ids, email domains with SSO requi","description":"Get the structure of an enterprise account: creation time, root and descendant account ids, email domains with SSO requirement, group and workspace ids. Needs an enterprise admin token with the enterprise.account:read scope. Use for \"Which workspaces and email domains does my Airtable enterprise account have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"enterprise_account_id":{"description":"Enterprise account id, starting with 'ent', for example 'entUBq2RGdihxl3vU'.","maxLength":200,"title":"Enterprise Account Id","type":"string"}},"required":["enterprise_account_id"],"title":"get_enterprise_accountArguments","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}}}}