{"openapi":"3.1.0","info":{"title":"Figma Design System (BYOK) API","version":"0.1.0","description":"Figma Design System (BYOK) lets an AI assistant read your own Figma Design System data through the Figma Design System API with a key you supply (personal access token). Read-only: 10 tools (list_team_components, list_team_component_sets, list_team_styles, get_component, get_component_set, get_style, list_file_component_sets, get_local_variables, get_published_variables, list_dev_resources). The...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-figma-design-system.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-figma-design-system/docs"},"termsOfService":"https://connectorbay.com/byok-figma-design-system/terms"},"servers":[{"url":"https://byok-figma-design-system.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-figma-design-system/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_team_components":{"post":{"operationId":"list_team_components","summary":"List the published components in a team library (needs the library_content:read scope) with key, name, description, sour","description":"List the published components in a team library (needs the library_content:read scope) with key, name, description, source file and node, and update time. Paged by cursor. Use for \"Which components has Figma team 1234567890 published\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Team id, the number in the Figma team page URL.","maxLength":200,"title":"Team Id","type":"string"},"page_size":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Items per page (1 to 1000, default 30).","title":"Page Size"},"after":{"anyOf":[{"maximum":999999999999,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor: the meta.cursor.after value of the previous answer to get the next page.","title":"After"},"before":{"anyOf":[{"maximum":999999999999,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor: the meta.cursor.before value of the previous answer to get the previous page.","title":"Before"}},"required":["team_id"],"title":"list_team_componentsArguments","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_component_sets":{"post":{"operationId":"list_team_component_sets","summary":"List the published component sets (variant groups) in a team library with key, name, description, source file and update","description":"List the published component sets (variant groups) in a team library with key, name, description, source file and update time. Paged by cursor. Use for \"Which component sets has Figma team 1234567890 published\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Team id, the number in the Figma team page URL.","maxLength":200,"title":"Team Id","type":"string"},"page_size":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Items per page (1 to 1000, default 30).","title":"Page Size"},"after":{"anyOf":[{"maximum":999999999999,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor: the meta.cursor.after value of the previous answer to get the next page.","title":"After"},"before":{"anyOf":[{"maximum":999999999999,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor: the meta.cursor.before value of the previous answer to get the previous page.","title":"Before"}},"required":["team_id"],"title":"list_team_component_setsArguments","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_styles":{"post":{"operationId":"list_team_styles","summary":"List the published styles in a team library (type FILL, TEXT, EFFECT or GRID) with key, name, description, source file a","description":"List the published styles in a team library (type FILL, TEXT, EFFECT or GRID) with key, name, description, source file and update time. Paged by cursor. Use for \"Which styles has Figma team 1234567890 published\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Team id, the number in the Figma team page URL.","maxLength":200,"title":"Team Id","type":"string"},"page_size":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Items per page (1 to 1000, default 30).","title":"Page Size"},"after":{"anyOf":[{"maximum":999999999999,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor: the meta.cursor.after value of the previous answer to get the next page.","title":"After"},"before":{"anyOf":[{"maximum":999999999999,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor: the meta.cursor.before value of the previous answer to get the previous page.","title":"Before"}},"required":["team_id"],"title":"list_team_stylesArguments","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_component":{"post":{"operationId":"get_component","summary":"Get one published component by its key: name, description, source file, node id, dates and the frame it sits in. Use for","description":"Get one published component by its key: name, description, source file, node id, dates and the frame it sits in. Use for \"What is published component k1a2b3c4 in Figma\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"key":{"description":"Unique key of the published component (the 'key' field in list answers).","maxLength":200,"title":"Key","type":"string"}},"required":["key"],"title":"get_componentArguments","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_component_set":{"post":{"operationId":"get_component_set","summary":"Get one published component set by its key: name, description, source file, node id and dates. Use for \"What is publishe","description":"Get one published component set by its key: name, description, source file, node id and dates. Use for \"What is published component set k1a2b3c4 in Figma\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"key":{"description":"Unique key of the published component set (the 'key' field in list answers).","maxLength":200,"title":"Key","type":"string"}},"required":["key"],"title":"get_component_setArguments","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_style":{"post":{"operationId":"get_style","summary":"Get one published style by its key: type, name, description, source file, node id and dates. Use for \"What is published ","description":"Get one published style by its key: type, name, description, source file, node id and dates. Use for \"What is published style k1a2b3c4 in Figma\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"key":{"description":"Unique key of the published style (the 'key' field in list answers).","maxLength":200,"title":"Key","type":"string"}},"required":["key"],"title":"get_styleArguments","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_file_component_sets":{"post":{"operationId":"list_file_component_sets","summary":"List the published component sets of one library file (a main file, not a branch) with key, name, description and node i","description":"List the published component sets of one library file (a main file, not a branch) with key, name, description and node id. Use for \"Which component sets does Figma file abc123XYZ publish\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"file_key":{"description":"File key: the part after /file/ or /design/ in a Figma file URL, for example 'abc123XYZ'.","maxLength":200,"title":"File Key","type":"string"}},"required":["file_key"],"title":"list_file_component_setsArguments","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_local_variables":{"post":{"operationId":"get_local_variables","summary":"Get the variables and variable collections defined in a file (modes, names, types, values per mode) plus remote variable","description":"Get the variables and variable collections defined in a file (modes, names, types, values per mode) plus remote variables it uses. Enterprise plan; needs the file_variables:read scope. Large files give large answers. Use for \"What design variables does Figma file abc123XYZ define\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"file_key":{"description":"File key: the part after /file/ or /design/ in a Figma file URL, for example 'abc123XYZ'.","maxLength":200,"title":"File Key","type":"string"}},"required":["file_key"],"title":"get_local_variablesArguments","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_published_variables":{"post":{"operationId":"get_published_variables","summary":"Get the variables and collections a library file has published, with keys and names (modes are not included; use get_loc","description":"Get the variables and collections a library file has published, with keys and names (modes are not included; use get_local_variables for mode values). Enterprise plan; needs the file_variables:read scope. Use for \"Which variables has Figma file abc123XYZ published to the library\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"file_key":{"description":"File key: the part after /file/ or /design/ in a Figma file URL, for example 'abc123XYZ'.","maxLength":200,"title":"File Key","type":"string"}},"required":["file_key"],"title":"get_published_variablesArguments","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_dev_resources":{"post":{"operationId":"list_dev_resources","summary":"List the dev resources (links to code, docs or tickets attached to design nodes) in a file, optionally only for some nod","description":"List the dev resources (links to code, docs or tickets attached to design nodes) in a file, optionally only for some node ids. Needs the file_dev_resources:read scope. Use for \"Which dev resource links are attached to Figma file abc123XYZ\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"file_key":{"description":"File key: the part after /file/ or /design/ in a Figma file URL, for example 'abc123XYZ'.","maxLength":200,"title":"File Key","type":"string"},"node_ids":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated node ids to restrict to, for example '1:2,1:3'.","title":"Node Ids"}},"required":["file_key"],"title":"list_dev_resourcesArguments","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}}}}