Sign in

v2

latestOpenAPI 3.0.3Apache 2.02026-07-31158109678.6 KB
articles

Initiate Upload

Initiate a new file upload within the article. Either use the link property to point to an existing file that resides elsewhere and will not be uploaded to Figshare or use the other 3 parameters (md5, name, size).

post/account/articles/{article_id}/files

Path parameters

article_idinteger required

Article unique identifier

Query parameters

pageinteger

Page number. Used for pagination with page_size

page_sizeinteger

The number of results included on a page. Used for pagination with page

limitinteger

Number of results included on a page. Used for pagination with query

offsetinteger

Where to start the listing (the offset of the first result). Used for pagination with limit

Request body

linkstring

Url for an existing file that will not be uploaded to Figshare

md5string

MD5 sum pre-computed on client side.

namestring

File name including the extension; can be omitted only for linked files.

sizeinteger

File size in bytes; can be omitted only for linked files.

folder_pathstring

Unix-style directory path of the file; only available if the file was uploaded within a folder structure

Example request

{
  "link": "http://figshare.com/file.txt",
  "md5": "6c16e6e7d7587bd078e5117dda01d565",
  "name": "test.py",
  "size": 70,
  "folder_path": "/level1/level2/level3"
}

Response

Created

locationstring url required

Url for item