{"openapi":"3.1.0","info":{"title":"IEEE Xplore (BYOK) API","version":"0.1.0","description":"IEEE Xplore (BYOK) lets an AI assistant read your own IEEE Xplore data through the IEEE Xplore API with a key you supply (IEEE Xplore API key). Read-only: 6 tools (search_articles, search_by_author, search_standards, get_article_by_number, get_article_by_doi, search_open_access). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-ieeexplore.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-ieeexplore/docs"},"termsOfService":"https://connectorbay.com/byok-ieeexplore/terms"},"servers":[{"url":"https://byok-ieeexplore.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-ieeexplore/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_articles":{"post":{"operationId":"search_articles","summary":"Search IEEE Xplore metadata (title, authors, abstract, publication, year, citing paper and patent counts, links) by free","description":"Search IEEE Xplore metadata (title, authors, abstract, publication, year, citing paper and patent counts, links) by free text with optional year and content type filters. Use for \"Find IEEE papers about federated learning from 2024 or later\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"querytext":{"description":"Free-text query over metadata and abstracts. Supports Boolean operators; at most two wildcard words, each with 3 or more characters before the *.","maxLength":300,"title":"Querytext","type":"string"},"content_type":{"anyOf":[{"enum":["Books","Conferences","Courses","Early Access","Journals","Magazines","Standards"],"type":"string"},{"type":"null"}],"default":null,"description":"Restrict to a content type (case sensitive): Books, Conferences, Courses, Early Access, Journals, Magazines or Standards.","title":"Content Type"},"start_year":{"anyOf":[{"maximum":2100,"minimum":1800,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents published in or after this year.","title":"Start Year"},"end_year":{"anyOf":[{"maximum":2100,"minimum":1800,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents published in or before this year.","title":"End Year"},"sort_field":{"anyOf":[{"enum":["article_number","article_title","publication_title"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort by article_number, article_title or publication_title (default: relevance).","title":"Sort Field"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"asc or desc; used together with sort_field.","title":"Sort Order"},"max_records":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many records to return (1 to 200).","title":"Max Records"},"start_record":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Sequence number of the first record to return, starting at 1; use it to page.","title":"Start Record"}},"required":["querytext"],"title":"search_articlesArguments","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/search_by_author":{"post":{"operationId":"search_by_author","summary":"Find IEEE Xplore documents by an author name (first or last name, at least 3 characters before any wildcard), optionally","description":"Find IEEE Xplore documents by an author name (first or last name, at least 3 characters before any wildcard), optionally from a given organization. Use for \"What has author Geoffrey Hinton published in IEEE Xplore\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"author":{"description":"Author name; searches first and last name. Use 3 or more characters before a trailing *.","maxLength":100,"title":"Author","type":"string"},"affiliation":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Part (3 or more characters) or all of an organization name to narrow the authors.","title":"Affiliation"},"start_year":{"anyOf":[{"maximum":2100,"minimum":1800,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents published in or after this year.","title":"Start Year"},"end_year":{"anyOf":[{"maximum":2100,"minimum":1800,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents published in or before this year.","title":"End Year"},"sort_field":{"anyOf":[{"enum":["article_number","article_title","publication_title"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort by article_number, article_title or publication_title (default: relevance).","title":"Sort Field"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"asc or desc; used together with sort_field.","title":"Sort Order"},"max_records":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many records to return (1 to 200).","title":"Max Records"},"start_record":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Sequence number of the first record to return, starting at 1; use it to page.","title":"Start Record"}},"required":["author"],"title":"search_by_authorArguments","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/search_standards":{"post":{"operationId":"search_standards","summary":"Search IEEE standards by free text, with standard number, status (for example active or draft), title and abstract. Use ","description":"Search IEEE standards by free text, with standard number, status (for example active or draft), title and abstract. Use for \"Which IEEE standards deal with wireless LANs\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"querytext":{"description":"Free-text query, for example 'wireless LAN' or '802.11'.","maxLength":300,"title":"Querytext","type":"string"},"content_type":{"anyOf":[{"const":"Standards","type":"string"},{"type":"null"}],"default":"Standards","description":"Content type; keep Standards to search standards.","title":"Content Type"},"max_records":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many records to return (1 to 200).","title":"Max Records"},"start_record":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Sequence number of the first record to return, starting at 1; use it to page.","title":"Start Record"}},"required":["querytext"],"title":"search_standardsArguments","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_article_by_number":{"post":{"operationId":"get_article_by_number","summary":"Get one IEEE Xplore document by its article number with abstract, authors, publication details and citing counts. Use fo","description":"Get one IEEE Xplore document by its article number with abstract, authors, publication details and citing counts. Use for \"Show the IEEE document with article number 6762843\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"article_number":{"description":"IEEE article number, for example '6762843'. Used alone; other filters are ignored.","maxLength":20,"title":"Article Number","type":"string"}},"required":["article_number"],"title":"get_article_by_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_article_by_doi":{"post":{"operationId":"get_article_by_doi","summary":"Look up an IEEE Xplore document by DOI and return its metadata and abstract. Use for \"Look up DOI 10.1109/5.771073 in IE","description":"Look up an IEEE Xplore document by DOI and return its metadata and abstract. Use for \"Look up DOI 10.1109/5.771073 in IEEE Xplore\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"doi":{"description":"DOI of the document, for example '10.1109/5.771073'. Used alone; other filters are ignored.","maxLength":100,"title":"Doi","type":"string"}},"required":["doi"],"title":"get_article_by_doiArguments","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/search_open_access":{"post":{"operationId":"search_open_access","summary":"Search IEEE Xplore for open access documents only, using free text. Use for \"Find open access IEEE papers about quantum ","description":"Search IEEE Xplore for open access documents only, using free text. Use for \"Find open access IEEE papers about quantum error correction\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"querytext":{"description":"Free-text query over metadata and abstracts.","maxLength":300,"title":"Querytext","type":"string"},"open_access":{"anyOf":[{"const":"True","type":"string"},{"type":"null"}],"default":"True","description":"Set to True to return open access documents only.","title":"Open Access"},"start_year":{"anyOf":[{"maximum":2100,"minimum":1800,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents published in or after this year.","title":"Start Year"},"end_year":{"anyOf":[{"maximum":2100,"minimum":1800,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents published in or before this year.","title":"End Year"},"max_records":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many records to return (1 to 200).","title":"Max Records"},"start_record":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Sequence number of the first record to return, starting at 1; use it to page.","title":"Start Record"}},"required":["querytext"],"title":"search_open_accessArguments","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}}}}