{"openapi":"3.1.0","info":{"title":"element14 (BYOK) API","version":"0.1.0","description":"element14 (BYOK) lets an AI assistant read your own element14 data through the element14 API with a key you supply (element14 API key). Read-only: 7 tools (search_parts, lookup_by_element14_part_number, lookup_by_manufacturer_part_number, get_part_stock, get_part_pricing, get_part_details, count_matching_parts). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-element14.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-element14/docs"},"termsOfService":"https://connectorbay.com/byok-element14/terms"},"servers":[{"url":"https://byok-element14.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-element14/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/search_parts":{"post":{"operationId":"search_parts","summary":"Search the electronic-parts catalog by keyword. Term must start with 'any:', for example 'any:fuse'. Returns name, brand","description":"Search the electronic-parts catalog by keyword. Term must start with 'any:', for example 'any:fuse'. Returns name, brand, manufacturer part number, pack size and technical attributes. Use for \"Find fast acting 500 mA fuses at Farnell UK\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"term":{"description":"Search term with the 'any:' prefix, for example 'any:fuse 500mA'.","maxLength":200,"title":"Term","type":"string"},"store":{"description":"Which regional store to query (sets currency, stock and prices).","enum":["uk.farnell.com","de.farnell.com","fr.farnell.com","it.farnell.com","es.farnell.com","nl.farnell.com","be.farnell.com","ie.farnell.com","at.farnell.com","ch.farnell.com","se.farnell.com","no.farnell.com","dk.farnell.com","fi.farnell.com","pl.farnell.com","cz.farnell.com","hu.farnell.com","ro.farnell.com","pt.farnell.com","export.farnell.com","www.newark.com","canada.newark.com","mexico.newark.com","au.element14.com","nz.element14.com","sg.element14.com","hk.element14.com","in.element14.com","my.element14.com","ph.element14.com","th.element14.com","tw.element14.com","kr.element14.com","vn.element14.com","cn.element14.com"],"title":"Store","type":"string"},"format":{"anyOf":[{"const":"json","type":"string"},{"type":"null"}],"default":"json","description":"Response format, always 'json'.","title":"Format"},"response_group":{"anyOf":[{"const":"small","type":"string"},{"type":"null"}],"default":"small","description":"Fixed response detail level, always 'small'.","title":"Response Group"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging.","title":"Offset"},"number_of_results":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 25).","title":"Number Of Results"},"filters":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Optional comma-separated filters: rohsCompliant, inStock.","title":"Filters"}},"required":["term","store"],"title":"search_partsArguments","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/lookup_by_element14_part_number":{"post":{"operationId":"lookup_by_element14_part_number","summary":"Look up parts by their element14, Farnell or Newark order code (SKU). Term must start with 'id:'; several codes can be s","description":"Look up parts by their element14, Farnell or Newark order code (SKU). Term must start with 'id:'; several codes can be separated by spaces. Use for \"Show Farnell part 1360825\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"term":{"description":"Order code(s) with the 'id:' prefix, for example 'id:1360825' or 'id:1360825 1278613'.","maxLength":200,"title":"Term","type":"string"},"store":{"description":"Which regional store to query (sets currency, stock and prices).","enum":["uk.farnell.com","de.farnell.com","fr.farnell.com","it.farnell.com","es.farnell.com","nl.farnell.com","be.farnell.com","ie.farnell.com","at.farnell.com","ch.farnell.com","se.farnell.com","no.farnell.com","dk.farnell.com","fi.farnell.com","pl.farnell.com","cz.farnell.com","hu.farnell.com","ro.farnell.com","pt.farnell.com","export.farnell.com","www.newark.com","canada.newark.com","mexico.newark.com","au.element14.com","nz.element14.com","sg.element14.com","hk.element14.com","in.element14.com","my.element14.com","ph.element14.com","th.element14.com","tw.element14.com","kr.element14.com","vn.element14.com","cn.element14.com"],"title":"Store","type":"string"},"format":{"anyOf":[{"const":"json","type":"string"},{"type":"null"}],"default":"json","description":"Response format, always 'json'.","title":"Format"},"response_group":{"anyOf":[{"const":"medium","type":"string"},{"type":"null"}],"default":"medium","description":"Fixed response detail level, always 'medium'.","title":"Response Group"}},"required":["term","store"],"title":"lookup_by_element14_part_numberArguments","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/lookup_by_manufacturer_part_number":{"post":{"operationId":"lookup_by_manufacturer_part_number","summary":"Look up parts by the manufacturer's own part number. Term must start with 'manuPartNum:', for example 'manuPartNum:LM339","description":"Look up parts by the manufacturer's own part number. Term must start with 'manuPartNum:', for example 'manuPartNum:LM339ADT'. Use for \"Find the Farnell listing for LM339ADT\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"term":{"description":"Manufacturer part number with the 'manuPartNum:' prefix.","maxLength":200,"title":"Term","type":"string"},"store":{"description":"Which regional store to query (sets currency, stock and prices).","enum":["uk.farnell.com","de.farnell.com","fr.farnell.com","it.farnell.com","es.farnell.com","nl.farnell.com","be.farnell.com","ie.farnell.com","at.farnell.com","ch.farnell.com","se.farnell.com","no.farnell.com","dk.farnell.com","fi.farnell.com","pl.farnell.com","cz.farnell.com","hu.farnell.com","ro.farnell.com","pt.farnell.com","export.farnell.com","www.newark.com","canada.newark.com","mexico.newark.com","au.element14.com","nz.element14.com","sg.element14.com","hk.element14.com","in.element14.com","my.element14.com","ph.element14.com","th.element14.com","tw.element14.com","kr.element14.com","vn.element14.com","cn.element14.com"],"title":"Store","type":"string"},"format":{"anyOf":[{"const":"json","type":"string"},{"type":"null"}],"default":"json","description":"Response format, always 'json'.","title":"Format"},"response_group":{"anyOf":[{"const":"medium","type":"string"},{"type":"null"}],"default":"medium","description":"Fixed response detail level, always 'medium'.","title":"Response Group"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging.","title":"Offset"},"number_of_results":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 25).","title":"Number Of Results"}},"required":["term","store"],"title":"lookup_by_manufacturer_part_numberArguments","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_part_stock":{"post":{"operationId":"get_part_stock","summary":"Show stock levels, warehouse breakdown, lead times and release status for parts matching a term ('any:', 'id:' or 'manuP","description":"Show stock levels, warehouse breakdown, lead times and release status for parts matching a term ('any:', 'id:' or 'manuPartNum:' prefix). Use for \"How many 0001.1001 fuses are in stock and where\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"term":{"description":"Search term with a prefix: 'any:...', 'id:...' or 'manuPartNum:...'.","maxLength":200,"title":"Term","type":"string"},"store":{"description":"Which regional store to query (sets currency, stock and prices).","enum":["uk.farnell.com","de.farnell.com","fr.farnell.com","it.farnell.com","es.farnell.com","nl.farnell.com","be.farnell.com","ie.farnell.com","at.farnell.com","ch.farnell.com","se.farnell.com","no.farnell.com","dk.farnell.com","fi.farnell.com","pl.farnell.com","cz.farnell.com","hu.farnell.com","ro.farnell.com","pt.farnell.com","export.farnell.com","www.newark.com","canada.newark.com","mexico.newark.com","au.element14.com","nz.element14.com","sg.element14.com","hk.element14.com","in.element14.com","my.element14.com","ph.element14.com","th.element14.com","tw.element14.com","kr.element14.com","vn.element14.com","cn.element14.com"],"title":"Store","type":"string"},"format":{"anyOf":[{"const":"json","type":"string"},{"type":"null"}],"default":"json","description":"Response format, always 'json'.","title":"Format"},"response_group":{"anyOf":[{"const":"inventory","type":"string"},{"type":"null"}],"default":"inventory","description":"Fixed response detail level, always 'inventory'.","title":"Response Group"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging.","title":"Offset"},"number_of_results":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 25).","title":"Number Of Results"},"filters":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Optional comma-separated filters: rohsCompliant, inStock.","title":"Filters"}},"required":["term","store"],"title":"get_part_stockArguments","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_part_pricing":{"post":{"operationId":"get_part_pricing","summary":"Show the quantity price breaks (from, to, unit cost in the store's currency) and VAT handling code for parts matching a ","description":"Show the quantity price breaks (from, to, unit cost in the store's currency) and VAT handling code for parts matching a term. List prices, not contract prices. Use for \"What are the price breaks for Farnell part 1360825\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"term":{"description":"Search term with a prefix: 'any:...', 'id:...' or 'manuPartNum:...'.","maxLength":200,"title":"Term","type":"string"},"store":{"description":"Which regional store to query (sets currency, stock and prices).","enum":["uk.farnell.com","de.farnell.com","fr.farnell.com","it.farnell.com","es.farnell.com","nl.farnell.com","be.farnell.com","ie.farnell.com","at.farnell.com","ch.farnell.com","se.farnell.com","no.farnell.com","dk.farnell.com","fi.farnell.com","pl.farnell.com","cz.farnell.com","hu.farnell.com","ro.farnell.com","pt.farnell.com","export.farnell.com","www.newark.com","canada.newark.com","mexico.newark.com","au.element14.com","nz.element14.com","sg.element14.com","hk.element14.com","in.element14.com","my.element14.com","ph.element14.com","th.element14.com","tw.element14.com","kr.element14.com","vn.element14.com","cn.element14.com"],"title":"Store","type":"string"},"format":{"anyOf":[{"const":"json","type":"string"},{"type":"null"}],"default":"json","description":"Response format, always 'json'.","title":"Format"},"response_group":{"anyOf":[{"const":"prices","type":"string"},{"type":"null"}],"default":"prices","description":"Fixed response detail level, always 'prices'.","title":"Response Group"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging.","title":"Offset"},"number_of_results":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 25).","title":"Number Of Results"},"filters":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Optional comma-separated filters: rohsCompliant, inStock.","title":"Filters"}},"required":["term","store"],"title":"get_part_pricingArguments","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_part_details":{"post":{"operationId":"get_part_details","summary":"Show the full record of parts matching a term: image, datasheets, price breaks, stock, country of origin, RoHS status an","description":"Show the full record of parts matching a term: image, datasheets, price breaks, stock, country of origin, RoHS status and commodity class (useful for customs). Use for \"Give me the datasheet, origin country and RoHS status of Farnell part 1360825\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"term":{"description":"Search term with a prefix: 'any:...', 'id:...' or 'manuPartNum:...'.","maxLength":200,"title":"Term","type":"string"},"store":{"description":"Which regional store to query (sets currency, stock and prices).","enum":["uk.farnell.com","de.farnell.com","fr.farnell.com","it.farnell.com","es.farnell.com","nl.farnell.com","be.farnell.com","ie.farnell.com","at.farnell.com","ch.farnell.com","se.farnell.com","no.farnell.com","dk.farnell.com","fi.farnell.com","pl.farnell.com","cz.farnell.com","hu.farnell.com","ro.farnell.com","pt.farnell.com","export.farnell.com","www.newark.com","canada.newark.com","mexico.newark.com","au.element14.com","nz.element14.com","sg.element14.com","hk.element14.com","in.element14.com","my.element14.com","ph.element14.com","th.element14.com","tw.element14.com","kr.element14.com","vn.element14.com","cn.element14.com"],"title":"Store","type":"string"},"format":{"anyOf":[{"const":"json","type":"string"},{"type":"null"}],"default":"json","description":"Response format, always 'json'.","title":"Format"},"response_group":{"anyOf":[{"const":"large","type":"string"},{"type":"null"}],"default":"large","description":"Fixed response detail level, always 'large'.","title":"Response Group"},"number_of_results":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 25).","title":"Number Of Results"}},"required":["term","store"],"title":"get_part_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/count_matching_parts":{"post":{"operationId":"count_matching_parts","summary":"Count how many catalog parts match a term, without returning the parts. Use for \"How many in-stock RoHS fuses does Farne","description":"Count how many catalog parts match a term, without returning the parts. Use for \"How many in-stock RoHS fuses does Farnell UK list\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"term":{"description":"Search term with a prefix: 'any:...', 'id:...' or 'manuPartNum:...'.","maxLength":200,"title":"Term","type":"string"},"store":{"description":"Which regional store to query (sets currency, stock and prices).","enum":["uk.farnell.com","de.farnell.com","fr.farnell.com","it.farnell.com","es.farnell.com","nl.farnell.com","be.farnell.com","ie.farnell.com","at.farnell.com","ch.farnell.com","se.farnell.com","no.farnell.com","dk.farnell.com","fi.farnell.com","pl.farnell.com","cz.farnell.com","hu.farnell.com","ro.farnell.com","pt.farnell.com","export.farnell.com","www.newark.com","canada.newark.com","mexico.newark.com","au.element14.com","nz.element14.com","sg.element14.com","hk.element14.com","in.element14.com","my.element14.com","ph.element14.com","th.element14.com","tw.element14.com","kr.element14.com","vn.element14.com","cn.element14.com"],"title":"Store","type":"string"},"format":{"anyOf":[{"const":"json","type":"string"},{"type":"null"}],"default":"json","description":"Response format, always 'json'.","title":"Format"},"response_group":{"anyOf":[{"const":"none","type":"string"},{"type":"null"}],"default":"none","description":"Fixed response detail level, always 'none'.","title":"Response Group"},"filters":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Optional comma-separated filters: rohsCompliant, inStock.","title":"Filters"}},"required":["term","store"],"title":"count_matching_partsArguments","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}}}}