figshare-api

name	figshare-api
description	Figshare API skill. Use when working with Figshare for token, articles, account. Covers 151 endpoints.
version	1.0.0
generator	lapsh

Figshare API

API version: 2.0.0

Auth

OAuth2

Base URL

https://api.figshare.com/v2

Setup

1. Configure auth: OAuth2
2. GET /token -- verify access
3. POST /token -- create first token

Endpoints

151 endpoints across 11 groups. See references/api-spec.lap for full details.

token

Method	Path	Description
GET	/token	Get OAuth token information
POST	/token	Create OAuth token

articles

Method	Path	Description
GET	/articles	Public Articles
POST	/articles/search	Public Articles Search
GET	/articles/{article_id}	View article details
GET	/articles/{article_id}/versions	List article versions
GET	/articles/{article_id}/versions/{version_id}	Article details for version
GET	/articles/{article_id}/versions/{version_id}/files	Article version file details
GET	/articles/{article_id}/download	Public Article Download
GET	/articles/{article_id}/versions/{version_id}/download	Public Article Version Download
GET	/articles/{article_id}/versions/{version_id}/embargo	Public Article Embargo for article version
GET	/articles/{article_id}/versions/{version_id}/confidentiality	Public Article Confidentiality for article version
GET	/articles/{article_id}/files	List article files
GET	/articles/{article_id}/files/{file_id}	Article file details

account

Method	Path	Description
POST	/account/articles/search	Private Articles search
GET	/account/articles	Private Articles
POST	/account/articles	Create new Article
GET	/account/articles/{article_id}	Article details
PUT	/account/articles/{article_id}	Update article
PATCH	/account/articles/{article_id}	Partially update article
DELETE	/account/articles/{article_id}	Delete article
GET	/account/articles/{article_id}/embargo	Article Embargo Details
PUT	/account/articles/{article_id}/embargo	Update Article Embargo
DELETE	/account/articles/{article_id}/embargo	Delete Article Embargo
POST	/account/articles/{article_id}/resource	Private Article Resource
POST	/account/articles/{article_id}/publish	Private Article Publish
POST	/account/articles/{article_id}/unpublish	Public Article Unpublish
POST	/account/articles/{article_id}/reserve_doi	Private Article Reserve DOI
POST	/account/articles/{article_id}/reserve_handle	Private Article Reserve Handle
GET	/account/articles/{article_id}/download	Private Article Download
PUT	/account/articles/{article_id}/versions/{version_id}	Update article version
PATCH	/account/articles/{article_id}/versions/{version_id}	Partially update article version
PUT	/account/articles/{article_id}/versions/{version_id}/update_thumb	Update article version thumbnail
GET	/account/articles/{article_id}/authors	List article authors
POST	/account/articles/{article_id}/authors	Add article authors
PUT	/account/articles/{article_id}/authors

collections

Method	Path	Description
GET	/collections	Public Collections
POST	/collections/search	Public Collections Search
GET	/collections/{collection_id}	Collection details
GET	/collections/{collection_id}/versions	Collection Versions list
GET	/collections/{collection_id}/versions/{version_id}	Collection Version details
GET	/collections/{collection_id}/articles	Public Collection Articles

item_types

Method	Path	Description
GET	/item_types	Item Types

projects

Method	Path	Description
GET	/projects	Public Projects
POST	/projects/search	Public Projects Search
GET	/projects/{project_id}	Public Project
GET	/projects/{project_id}/articles	Public Project Articles

institutions

Method	Path	Description
GET	/institutions/{institution_string_id}/articles/filter-by	Public Institution Articles

categories

Method	Path	Description
GET	/categories	Public Categories

licenses

Method	Path	Description
GET	/licenses	Public Licenses

institution

Method	Path	Description
POST	/institution/hrfeed/upload	Private Institution HRfeed Upload

file

Method	Path	Description
GET	/file/download/{file_id}	Public File Download

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all token?" -> GET /token
• "Create a token?" -> POST /token
• "List all articles?" -> GET /articles
• "Create a search?" -> POST /articles/search
• "Get article details?" -> GET /articles/{article_id}
• "List all versions?" -> GET /articles/{article_id}/versions
• "Get version details?" -> GET /articles/{article_id}/versions/{version_id}
• "List all files?" -> GET /articles/{article_id}/versions/{version_id}/files
• "List all download?" -> GET /articles/{article_id}/download
• "List all download?" -> GET /articles/{article_id}/versions/{version_id}/download
• "List all embargo?" -> GET /articles/{article_id}/versions/{version_id}/embargo
• "List all confidentiality?" -> GET /articles/{article_id}/versions/{version_id}/confidentiality
• "List all files?" -> GET /articles/{article_id}/files
• "Get file details?" -> GET /articles/{article_id}/files/{file_id}
• "Create a search?" -> POST /account/articles/search
• "List all articles?" -> GET /account/articles
• "Create a article?" -> POST /account/articles
• "Get article details?" -> GET /account/articles/{article_id}
• "Update a article?" -> PUT /account/articles/{article_id}
• "Partially update a article?" -> PATCH /account/articles/{article_id}
• "Delete a article?" -> DELETE /account/articles/{article_id}
• "List all embargo?" -> GET /account/articles/{article_id}/embargo
• "Create a resource?" -> POST /account/articles/{article_id}/resource
• "Create a publish?" -> POST /account/articles/{article_id}/publish
• "Create a unpublish?" -> POST /account/articles/{article_id}/unpublish
• "Create a reserve_doi?" -> POST /account/articles/{article_id}/reserve_doi
• "Create a reserve_handle?" -> POST /account/articles/{article_id}/reserve_handle
• "List all download?" -> GET /account/articles/{article_id}/download
• "Update a version?" -> PUT /account/articles/{article_id}/versions/{version_id}
• "Partially update a version?" -> PATCH /account/articles/{article_id}/versions/{version_id}
• "List all authors?" -> GET /account/articles/{article_id}/authors
• "Create a author?" -> POST /account/articles/{article_id}/authors
• "Delete a author?" -> DELETE /account/articles/{article_id}/authors/{author_id}
• "List all categories?" -> GET /account/articles/{article_id}/categories
• "Create a category?" -> POST /account/articles/{article_id}/categories
• "Delete a category?" -> DELETE /account/articles/{article_id}/categories/{category_id}
• "List all confidentiality?" -> GET /account/articles/{article_id}/confidentiality

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP