{"openapi":"3.1.0","info":{"title":"Airtable (BYOK) API","version":"0.1.0","description":"Airtable (BYOK) lets an AI assistant read your own Airtable data through the Airtable API with a key you supply (personal access token (scopes: data.records:read, schema.bases:read)). Read-only: 7 tools (whoami, list_bases, get_base_schema, list_views, list_records, get_record, list_record_comments). 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-airtable.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-airtable/docs"},"termsOfService":"https://connectorbay.com/byok-airtable/terms"},"servers":[{"url":"https://byok-airtable.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-airtable/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/whoami":{"post":{"operationId":"whoami","summary":"Show the id (and email, if the token has the user.email:read scope) of the Airtable user the token belongs to. Use for \"","description":"Show the id (and email, if the token has the user.email:read scope) of the Airtable user the token belongs to. Use for \"Which Airtable user does my token belong to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"whoamiArguments","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_bases":{"post":{"operationId":"list_bases","summary":"List the bases the token can access with id, name and permission level (up to 1000 per call; use offset for more). Needs","description":"List the bases the token can access with id, name and permission level (up to 1000 per call; use offset for more). Needs scope schema.bases:read. Use for \"Which Airtable bases can I access\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"offset":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's offset field for the next page.","title":"Offset"}},"title":"list_basesArguments","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_base_schema":{"post":{"operationId":"get_base_schema","summary":"Get all tables of a base with their fields (id, name, type, description) and views (id, name, type). Needs scope schema.","description":"Get all tables of a base with their fields (id, name, type, description) and views (id, name, type). Needs scope schema.bases:read. Use for \"What tables and fields does my Airtable base have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"base_id":{"description":"Base id, starts with 'app', for example 'appA1b2C3d4E5f6G'. list_bases returns it.","maxLength":200,"title":"Base Id","type":"string"}},"required":["base_id"],"title":"get_base_schemaArguments","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_views":{"post":{"operationId":"list_views","summary":"List the views of a base with id, name and type (grid, form, calendar, gallery, kanban, timeline, block). Needs scope sc","description":"List the views of a base with id, name and type (grid, form, calendar, gallery, kanban, timeline, block). Needs scope schema.bases:read. Use for \"What views exist in my Airtable base\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"base_id":{"description":"Base id, starts with 'app', for example 'appA1b2C3d4E5f6G'. list_bases returns it.","maxLength":200,"title":"Base Id","type":"string"}},"required":["base_id"],"title":"list_viewsArguments","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_records":{"post":{"operationId":"list_records","summary":"List records of a table (up to 100 per page; pass the previous offset for the next page). Supports a view, a filter form","description":"List records of a table (up to 100 per page; pass the previous offset for the next page). Supports a view, a filter formula, one sort field and a cap on total records. Empty cells are omitted. Needs scope data.records:read. Use for \"Show the first 20 records of the Contacts table in my Airtable base\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"base_id":{"description":"Base id, starts with 'app', for example 'appA1b2C3d4E5f6G'. list_bases returns it.","maxLength":200,"title":"Base Id","type":"string"},"table":{"description":"Table id (starts with 'tbl', preferred) or table name. get_base_schema returns both.","maxLength":200,"title":"Table","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"Records per page (1 to 100, default 100).","title":"Page Size"},"max_records":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Stop after this many records in total across pages.","title":"Max Records"},"offset":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's offset field for the next page.","title":"Offset"},"view":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Name or id of a view; only its records are returned, in its order.","title":"View"},"filter_by_formula":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"An Airtable formula; records where it is true are returned, for example \"{Status}='Open'\".","title":"Filter By Formula"},"sort_field":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Field name to sort by (overrides the view's sort).","title":"Sort Field"},"sort_direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"asc (default) or desc; used with sort_field.","title":"Sort Direction"},"cell_format":{"anyOf":[{"enum":["json","string"],"type":"string"},{"type":"null"}],"default":"json","description":"json (default) gives typed values; string gives display text and needs time_zone and user_locale.","title":"Cell Format"},"time_zone":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"IANA time zone, for example 'Europe/London'; needed when cell_format is string.","title":"Time Zone"},"user_locale":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Locale such as 'en-gb'; needed when cell_format is string.","title":"User Locale"}},"required":["base_id","table"],"title":"list_recordsArguments","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_record":{"post":{"operationId":"get_record","summary":"Get one record of a table with its fields and creation time. Empty cells are omitted. Needs scope data.records:read. Use","description":"Get one record of a table with its fields and creation time. Empty cells are omitted. Needs scope data.records:read. Use for \"Show Airtable record recA1b2C3d4E5f6G from the Contacts table\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"base_id":{"description":"Base id, starts with 'app', for example 'appA1b2C3d4E5f6G'. list_bases returns it.","maxLength":200,"title":"Base Id","type":"string"},"table":{"description":"Table id (starts with 'tbl', preferred) or table name. get_base_schema returns both.","maxLength":200,"title":"Table","type":"string"},"record_id":{"description":"Record id, starts with 'rec'.","maxLength":200,"title":"Record Id","type":"string"},"cell_format":{"anyOf":[{"enum":["json","string"],"type":"string"},{"type":"null"}],"default":"json","description":"json (default) gives typed values; string gives display text and needs time_zone and user_locale.","title":"Cell Format"},"time_zone":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"IANA time zone; needed when cell_format is string.","title":"Time Zone"},"user_locale":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Locale such as 'en-gb'; needed when cell_format is string.","title":"User Locale"}},"required":["base_id","table","record_id"],"title":"get_recordArguments","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_record_comments":{"post":{"operationId":"list_record_comments","summary":"List the comments on a record, newest first, with text, author and times (up to 100 per page). Needs scope data.recordCo","description":"List the comments on a record, newest first, with text, author and times (up to 100 per page). Needs scope data.recordComments:read. Use for \"What comments are on Airtable record recA1b2C3d4E5f6G\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"base_id":{"description":"Base id, starts with 'app', for example 'appA1b2C3d4E5f6G'. list_bases returns it.","maxLength":200,"title":"Base Id","type":"string"},"table":{"description":"Table id (starts with 'tbl', preferred) or table name. get_base_schema returns both.","maxLength":200,"title":"Table","type":"string"},"record_id":{"description":"Record id, starts with 'rec'.","maxLength":200,"title":"Record Id","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"Comments per page (1 to 100, default 100).","title":"Page Size"},"offset":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's offset field for the next page.","title":"Offset"}},"required":["base_id","table","record_id"],"title":"list_record_commentsArguments","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}}}}