{"openapi":"3.1.0","info":{"title":"Figshare (BYOK) API","version":"0.1.0","description":"Figshare (BYOK) lets an AI assistant read your own Figshare data through the Figshare API with a key you supply (Figshare personal token). Read-only: 11 tools (get_account, list_my_articles, get_my_article, list_my_collections, list_my_projects, search_public_articles, list_public_articles, get_public_article, list_article_files, list_public_collections, get_public_collection). The BYOK key...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-figshare.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-figshare/docs"},"termsOfService":"https://connectorbay.com/byok-figshare/terms"},"servers":[{"url":"https://byok-figshare.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-figshare/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/get_account":{"post":{"operationId":"get_account","summary":"Show the Figshare account the token belongs to: name, ORCID, storage quota and quota used. Use for \"How much Figshare st","description":"Show the Figshare account the token belongs to: name, ORCID, storage quota and quota used. Use for \"How much Figshare storage have I used\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_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}},"/v1/tools/list_my_articles":{"post":{"operationId":"list_my_articles","summary":"List the items (articles, datasets, software) in your own Figshare account, including private drafts, with title, DOI an","description":"List the items (articles, datasets, software) in your own Figshare account, including private drafts, with title, DOI and dates. Use for \"What datasets do I have in my Figshare account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 100; the service allows more).","title":"Page Size"},"page":{"anyOf":[{"maximum":5000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (the service caps it at 5000).","title":"Page"}},"title":"list_my_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/get_my_article":{"post":{"operationId":"get_my_article","summary":"Get one of your own items, including drafts: description, tags, categories, license, authors and files. Use for \"Show th","description":"Get one of your own items, including drafts: description, tags, categories, license, authors and files. Use for \"Show the details and files of my Figshare item 3623549\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"article_id":{"description":"Numeric Figshare article (item) ID, for example 3623549.","title":"Article Id","type":"integer"}},"required":["article_id"],"title":"get_my_articleArguments","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_my_collections":{"post":{"operationId":"list_my_collections","summary":"List the collections in your own Figshare account with title, DOI and publication date. Use for \"Which Figshare collecti","description":"List the collections in your own Figshare account with title, DOI and publication date. Use for \"Which Figshare collections do I own\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 100; the service allows more).","title":"Page Size"},"page":{"anyOf":[{"maximum":5000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (the service caps it at 5000).","title":"Page"},"order":{"anyOf":[{"enum":["published_date","modified_date","views","shares","cites"],"type":"string"},{"type":"null"}],"default":"published_date","description":"Sort field: published_date, modified_date, views, shares or cites.","title":"Order"},"order_direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction: asc or desc.","title":"Order Direction"}},"title":"list_my_collectionsArguments","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_my_projects":{"post":{"operationId":"list_my_projects","summary":"List the projects you can access in Figshare with your role and storage type. Use for \"Which Figshare projects am I part","description":"List the projects you can access in Figshare with your role and storage type. Use for \"Which Figshare projects am I part of\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 100; the service allows more).","title":"Page Size"},"page":{"anyOf":[{"maximum":5000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (the service caps it at 5000).","title":"Page"},"roles":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated roles to require: owner, collaborator, viewer.","title":"Roles"},"storage":{"anyOf":[{"enum":["group","individual"],"type":"string"},{"type":"null"}],"default":null,"description":"Filter by storage: group or individual.","title":"Storage"}},"title":"list_my_projectsArguments","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_public_articles":{"post":{"operationId":"search_public_articles","summary":"Search public Figshare items (datasets, papers, posters, software) by text, with optional item type and date filters. Us","description":"Search public Figshare items (datasets, papers, posters, software) by text, with optional item type and date filters. Use for \"Find public Figshare datasets about coral reef bleaching\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search_for":{"description":"Search text of at least 3 characters; Figshare search syntax such as :title: or :author: is accepted.","maxLength":300,"title":"Search For","type":"string"},"item_type":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Item type number: 1 figure, 2 media, 3 dataset, 5 poster, 6 journal contribution, 7 presentation, 8 thesis, 9 software, 11 online resource, 12 preprint, 13 book, 14 conference contribution, 15 chapter, 16 peer review, 18 report, 24 workflow, 29 model.","title":"Item Type"},"published_since":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items published after this date, YYYY-MM-DD.","title":"Published Since"},"order":{"anyOf":[{"enum":["published_date","created_date","modified_date","views","shares","downloads","cites"],"type":"string"},{"type":"null"}],"default":"published_date","description":"Sort field: published_date, created_date, modified_date, views, shares, downloads or cites.","title":"Order"},"order_direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction: asc or desc.","title":"Order Direction"},"page":{"anyOf":[{"maximum":5000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Results per page (1 to 100).","title":"Page Size"}},"required":["search_for"],"title":"search_public_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/list_public_articles":{"post":{"operationId":"list_public_articles","summary":"List public Figshare items, newest first by default, filtered by item type, institution, DOI or dates. Use for \"What dat","description":"List public Figshare items, newest first by default, filtered by item type, institution, DOI or dates. Use for \"What datasets were published on Figshare most recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"item_type":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Item type number: 1 figure, 2 media, 3 dataset, 5 poster, 6 journal contribution, 7 presentation, 8 thesis, 9 software, 11 online resource, 12 preprint, 13 book, 14 conference contribution, 15 chapter, 16 peer review, 18 report, 24 workflow, 29 model.","title":"Item Type"},"institution":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Numeric institution ID to restrict to.","title":"Institution"},"doi":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Return only the item with this DOI.","title":"Doi"},"published_since":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only items published after this date, YYYY-MM-DD.","title":"Published Since"},"modified_since":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only items modified after this date, YYYY-MM-DD.","title":"Modified Since"},"order":{"anyOf":[{"enum":["published_date","created_date","modified_date","views","shares","downloads","cites"],"type":"string"},{"type":"null"}],"default":"published_date","description":"Sort field: published_date, created_date, modified_date, views, shares, downloads or cites.","title":"Order"},"order_direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction: asc or desc.","title":"Order Direction"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 100; the service allows more).","title":"Page Size"},"page":{"anyOf":[{"maximum":5000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (the service caps it at 5000).","title":"Page"}},"title":"list_public_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/get_public_article":{"post":{"operationId":"get_public_article","summary":"Get one public Figshare item with description, authors, tags, categories, license, citation and file list. Use for \"Show","description":"Get one public Figshare item with description, authors, tags, categories, license, citation and file list. Use for \"Show the details of Figshare item 3623549\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"article_id":{"description":"Numeric Figshare article (item) ID, for example 3623549.","title":"Article Id","type":"integer"}},"required":["article_id"],"title":"get_public_articleArguments","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_article_files":{"post":{"operationId":"list_article_files","summary":"List the files of a public Figshare item with name, size, MIME type, checksum and download URL. Use for \"Which files doe","description":"List the files of a public Figshare item with name, size, MIME type, checksum and download URL. Use for \"Which files does Figshare item 3623549 contain\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"article_id":{"description":"Numeric Figshare article (item) ID, for example 3623549.","title":"Article Id","type":"integer"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 100; the service allows more).","title":"Page Size"},"page":{"anyOf":[{"maximum":5000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (the service caps it at 5000).","title":"Page"}},"required":["article_id"],"title":"list_article_filesArguments","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_public_collections":{"post":{"operationId":"list_public_collections","summary":"List public Figshare collections (curated groups of items) filtered by institution, DOI or dates. Use for \"What Figshare","description":"List public Figshare collections (curated groups of items) filtered by institution, DOI or dates. Use for \"What Figshare collections were published recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"institution":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Numeric institution ID to restrict to.","title":"Institution"},"doi":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Return only the collection with this DOI.","title":"Doi"},"published_since":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only collections published after this date, YYYY-MM-DD.","title":"Published Since"},"order":{"anyOf":[{"enum":["published_date","created_date","modified_date","views","shares","cites"],"type":"string"},{"type":"null"}],"default":"published_date","description":"Sort field: published_date, created_date, modified_date, views, shares or cites.","title":"Order"},"order_direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction: asc or desc.","title":"Order Direction"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 100; the service allows more).","title":"Page Size"},"page":{"anyOf":[{"maximum":5000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (the service caps it at 5000).","title":"Page"}},"title":"list_public_collectionsArguments","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_public_collection":{"post":{"operationId":"get_public_collection","summary":"Get one public Figshare collection with description, authors, tags, categories and the number of items. Use for \"Describ","description":"Get one public Figshare collection with description, authors, tags, categories and the number of items. Use for \"Describe Figshare collection 3290024\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"collection_id":{"description":"Numeric Figshare collection ID, for example 3290024.","title":"Collection Id","type":"integer"}},"required":["collection_id"],"title":"get_public_collectionArguments","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}}}}