action=upload

Upload a file, or get the status of pending uploads.

Several methods are available:

• Upload file contents directly, using thefile parameter.
• Upload the file in pieces, using thefilesize,chunk, andoffset parameters.
• Have the MediaWiki server fetch a file from a URL, using theurl parameter.
• Complete an earlier upload that failed due to warnings, was uploaded in pieces, or stored otherwise in the upload stash, using thefilekey parameter.

Note that the HTTP POST must be done as a file upload (i.e. usingmultipart/form-data) when sending thefile orchunk.

Python

"""    upload_file_directly.py    MediaWiki API Demos    Demo of `Upload` module: Sending post request to upload a file directly    MIT license"""importrequestsS=requests.Session()URL="https://test.wikipedia.org/w/api.php"FILE_PATH='f.jpg'# Step 1: Retrieve a login tokenPARAMS_1={"action":"query","meta":"tokens","type":"login","format":"json"}R=S.get(url=URL,params=PARAMS_1)DATA=R.json()LOGIN_TOKEN=DATA["query"]["tokens"]["logintoken"]# Step 2: Send a post request to login. Use of main account for login is not# supported. Obtain credentials via Special:BotPasswords# (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpasswordPARAMS_2={"action":"login","lgname":"bot_username","lgpassword":"bot_password","format":"json","lgtoken":LOGIN_TOKEN}R=S.post(URL,data=PARAMS_2)# Step 3: Obtain a CSRF tokenPARAMS_3={"action":"query","meta":"tokens","format":"json"}R=S.get(url=URL,params=PARAMS_3)DATA=R.json()CSRF_TOKEN=DATA["query"]["tokens"]["csrftoken"]# Step 4: Post request to upload a file directlyPARAMS_4={"action":"upload","filename":"file_1.jpg","format":"json","token":CSRF_TOKEN,"ignorewarnings":1}FILE={'file':('file_1.jpg',open(FILE_PATH,'rb'),'multipart/form-data')}R=S.post(URL,files=FILE,data=PARAMS_4)DATA=R.json()print(DATA)

PHP

<?php/*    upload_file_directly.php    MediaWiki API DemosDemo of `Upload` module: Sending post request to upload a file directly    MIT license*/$endPoint="https://test.wikipedia.org/w/api.php";$login_Token=getLoginToken();// Step 1loginRequest($login_Token);// Step 2$csrf_Token=getCSRFToken();// Step 3upload($csrf_Token);// Step 4// Step 1: GET request to fetch login tokenfunctiongetLoginToken(){global$endPoint;$params1=["action"=>"query","meta"=>"tokens","type"=>"login","format"=>"json"];$url=$endPoint."?".http_build_query($params1);$ch=curl_init($url);curl_setopt($ch,CURLOPT_RETURNTRANSFER,true);curl_setopt($ch,CURLOPT_COOKIEJAR,"cookie.txt");curl_setopt($ch,CURLOPT_COOKIEFILE,"cookie.txt");$output=curl_exec($ch);curl_close($ch);$result=json_decode($output,true);return$result["query"]["tokens"]["logintoken"];}// Step 2: POST request to log in. Use of main account for login is not// supported. Obtain credentials via Special:BotPasswords// (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpasswordfunctionloginRequest($logintoken){global$endPoint;$params2=["action"=>"login","lgname"=>"bot_user_name","lgpassword"=>"bot_password","lgtoken"=>$logintoken,"format"=>"json"];$ch=curl_init();curl_setopt($ch,CURLOPT_URL,$endPoint);curl_setopt($ch,CURLOPT_POST,true);curl_setopt($ch,CURLOPT_POSTFIELDS,http_build_query($params2));curl_setopt($ch,CURLOPT_RETURNTRANSFER,true);curl_setopt($ch,CURLOPT_COOKIEJAR,"cookie.txt");curl_setopt($ch,CURLOPT_COOKIEFILE,"cookie.txt");$output=curl_exec($ch);curl_close($ch);}// Step 3: GET request to fetch CSRF tokenfunctiongetCSRFToken(){global$endPoint;$params3=["action"=>"query","meta"=>"tokens","format"=>"json"];$url=$endPoint."?".http_build_query($params3);$ch=curl_init($url);curl_setopt($ch,CURLOPT_RETURNTRANSFER,true);curl_setopt($ch,CURLOPT_COOKIEJAR,"cookie.txt");curl_setopt($ch,CURLOPT_COOKIEFILE,"cookie.txt");$output=curl_exec($ch);curl_close($ch);$result=json_decode($output,true);return$result["query"]["tokens"]["csrftoken"];}// Step 4: POST request to upload a file directlyfunctionupload($csrftoken){global$endPoint;$params4=["action"=>"upload","filename"=>"Sandboxfile1.jpg","file"=>curl_file_create("localfile.jpg","image/jpeg","Sandboxfile1.jpg"),"ignorewarnings"=>"1","token"=>$csrftoken,"format"=>"json"];$ch=curl_init();curl_setopt($ch,CURLOPT_URL,$endPoint);curl_setopt($ch,CURLOPT_POST,true);curl_setopt($ch,CURLOPT_HTTPHEADER,array('Content-type: multipart/form-data'));curl_setopt($ch,CURLOPT_POSTFIELDS,$params4);curl_setopt($ch,CURLOPT_RETURNTRANSFER,true);curl_setopt($ch,CURLOPT_COOKIEJAR,"cookie.txt");curl_setopt($ch,CURLOPT_COOKIEFILE,"cookie.txt");$output=curl_exec($ch);curl_close($ch);echo($output);}

JavaScript

/*    upload_file_directly.js    MediaWiki API Demos    Demo of `Upload` module: Sending post request to upload a file directly    MIT license*/varfs=require('fs'),request=require('request').defaults({jar:true}),url="https://test.wikipedia.org/w/api.php";// Step 1: GET request to fetch login tokenfunctiongetLoginToken(){varparams_0={action:"query",meta:"tokens",type:"login",format:"json"};request.get({url:url,qs:params_0},function(error,res,body){if(error){return;}vardata=JSON.parse(body);loginRequest(data.query.tokens.logintoken);});}// Step 2: POST request to log in.// Use of main account for login is not// supported. Obtain credentials via Special:BotPasswords// (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpasswordfunctionloginRequest(login_token){varparams_1={action:"login",lgname:"bot_username",lgpassword:"bot_password",lgtoken:login_token,format:"json"};request.post({url:url,form:params_1},function(error,res,body){if(error){return;}getCsrfToken();});}// Step 3: GET request to fetch CSRF tokenfunctiongetCsrfToken(){varparams_2={action:"query",meta:"tokens",format:"json"};request.get({url:url,qs:params_2},function(error,res,body){if(error){return;}vardata=JSON.parse(body);upload(data.query.tokens.csrftoken);});}// Step 4: POST request to upload a file directlyfunctionupload(csrf_token){varparams_3={action:"upload",filename:"Sandboxfile1.jpg",ignorewarnings:"1",token:csrf_token,format:"json"};varfile={file:fs.createReadStream('My.jpg')};varformData=Object.assign({},params_3,file);request.post({url:url,formData:formData},function(error,res,body){body=JSON.parse(body);if(error){return;}elseif(body.upload.result==="Success"){console.log("File Uploaded :)");}});}// Start From Step 1getLoginToken();

MediaWiki JS

/*    upload_file_directly.js    MediaWiki API Demos    Demo of `Upload` module: Sending post request to upload a file directly    MIT license*/varparam={filename:'File_1.jpg',format:'json',ignorewarnings:1},fileInput=$('<input/>').attr('type','file'),submitBtn=$('<input/>').attr('type','button').attr('value','Upload'),api=newmw.Api();$('#bodyContent').append([fileInput,submitBtn]);$(submitBtn).on('click',function(){api.upload(fileInput[0],param).done(function(data){console.log(data.upload.filename+' has sucessfully uploaded.');}).fail(function(data){console.log(data);});});

Python

"""    upload_file_from_url.py    MediaWiki API Demos    Demo of `Upload` module: Post request to upload a file from a URL    MIT license"""importrequestsS=requests.Session()URL="https://test.wikipedia.org/w/api.php"# Step 1: Retrieve a login tokenPARAMS_1={"action":"query","meta":"tokens","type":"login","format":"json"}R=S.get(url=URL,params=PARAMS_1)DATA=R.json()LOGIN_TOKEN=DATA["query"]["tokens"]["logintoken"]# Step 2: Send a post request to login. Use of main account for login is not# supported. Obtain credentials via Special:BotPasswords# (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpasswordPARAMS_2={"action":"login","lgname":"bot_username","lgpassword":"bot_password","format":"json","lgtoken":LOGIN_TOKEN}R=S.post(URL,data=PARAMS_2)# Step 3: While logged in, retrieve a CSRF tokenPARAMS_3={"action":"query","meta":"tokens","format":"json"}R=S.get(url=URL,params=PARAMS_3)DATA=R.json()CSRF_TOKEN=DATA["query"]["tokens"]["csrftoken"]# Step 4: Post request to upload a file from a URLPARAMS_4={"action":"upload","filename":"new_image.jpg","url":"https://farm9.staticflickr.com/8213/8300206113_374c017fc5.jpg","format":"json","token":CSRF_TOKEN,"ignorewarnings":1}R=S.post(URL,data=PARAMS_4)DATA=R.json()print(DATA)

PHP

<?php/*    upload_file_from_url.php    MediaWiki API DemosDemo of `Upload` module: Post request to upload a file from a URL    MIT license*/$endPoint="https://test.wikipedia.org/w/api.php";$login_Token=getLoginToken();// Step 1loginRequest($login_Token);// Step 2$csrf_Token=getCSRFToken();// Step 3upload($csrf_Token);// Step 4// Step 1: GET request to fetch login tokenfunctiongetLoginToken(){global$endPoint;$params1=["action"=>"query","meta"=>"tokens","type"=>"login","format"=>"json"];$url=$endPoint."?".http_build_query($params1);$ch=curl_init($url);curl_setopt($ch,CURLOPT_RETURNTRANSFER,true);curl_setopt($ch,CURLOPT_COOKIEJAR,"cookie.txt");curl_setopt($ch,CURLOPT_COOKIEFILE,"cookie.txt");$output=curl_exec($ch);curl_close($ch);$result=json_decode($output,true);return$result["query"]["tokens"]["logintoken"];}// Step 2: POST request to log in. Use of main account for login is not// supported. Obtain credentials via Special:BotPasswords// (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpasswordfunctionloginRequest($logintoken){global$endPoint;$params2=["action"=>"login","lgname"=>"bot_user_name","lgpassword"=>"bot_password","lgtoken"=>$logintoken,"format"=>"json"];$ch=curl_init();curl_setopt($ch,CURLOPT_URL,$endPoint);curl_setopt($ch,CURLOPT_POST,true);curl_setopt($ch,CURLOPT_POSTFIELDS,http_build_query($params2));curl_setopt($ch,CURLOPT_RETURNTRANSFER,true);curl_setopt($ch,CURLOPT_COOKIEJAR,"cookie.txt");curl_setopt($ch,CURLOPT_COOKIEFILE,"cookie.txt");$output=curl_exec($ch);curl_close($ch);}// Step 3: GET request to fetch CSRF tokenfunctiongetCSRFToken(){global$endPoint;$params3=["action"=>"query","meta"=>"tokens","format"=>"json"];$url=$endPoint."?".http_build_query($params3);$ch=curl_init($url);curl_setopt($ch,CURLOPT_RETURNTRANSFER,true);curl_setopt($ch,CURLOPT_COOKIEJAR,"cookie.txt");curl_setopt($ch,CURLOPT_COOKIEFILE,"cookie.txt");$output=curl_exec($ch);curl_close($ch);$result=json_decode($output,true);return$result["query"]["tokens"]["csrftoken"];}// Step 4: POST request to upload a file from a URLfunctionupload($csrftoken){global$endPoint;$params4=["action"=>"upload","filename"=>"Test-Jayprakash12345.jpg","url"=>"https://farm9.staticflickr.com/8213/8300206113_374c017fc5.jpg","ignorewarnings"=>"1","token"=>$csrftoken,"format"=>"json"];$ch=curl_init();curl_setopt($ch,CURLOPT_URL,$endPoint);curl_setopt($ch,CURLOPT_POST,true);curl_setopt($ch,CURLOPT_POSTFIELDS,http_build_query($params4));curl_setopt($ch,CURLOPT_RETURNTRANSFER,true);curl_setopt($ch,CURLOPT_COOKIEJAR,"cookie.txt");curl_setopt($ch,CURLOPT_COOKIEFILE,"cookie.txt");$output=curl_exec($ch);curl_close($ch);echo($output);}

JavaScript

/*    upload_file_from_url.js    MediaWiki API Demos    Demo of `Upload` module: Post request to upload a file from a URL    MIT license*/varrequest=require('request').defaults({jar:true}),url="https://test.wikipedia.org/w/api.php";// Step 1: GET request to fetch login tokenfunctiongetLoginToken(){varparams_0={action:"query",meta:"tokens",type:"login",format:"json"};request.get({url:url,qs:params_0},function(error,res,body){if(error){return;}vardata=JSON.parse(body);loginRequest(data.query.tokens.logintoken);});}// Step 2: POST request to log in.// Use of main account for login is not// supported. Obtain credentials via Special:BotPasswords// (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpasswordfunctionloginRequest(login_token){varparams_1={action:"login",lgname:"bot_username",lgpassword:"bot_password",lgtoken:login_token,format:"json"};request.post({url:url,form:params_1},function(error,res,body){if(error){return;}getCsrfToken();});}// Step 3: GET request to fetch CSRF tokenfunctiongetCsrfToken(){varparams_2={action:"query",meta:"tokens",format:"json"};request.get({url:url,qs:params_2},function(error,res,body){if(error){return;}vardata=JSON.parse(body);editRequest(data.query.tokens.csrftoken);});}// Step 4: POST request to upload a file from a URLfunctioneditRequest(csrf_token){varparams_3={action:"upload",filename:"Test-ABCD.jpg",url:"https://farm9.staticflickr.com/8213/8300206113_374c017fc5.jpg",ignorewarnings:"1",token:csrf_token,format:"json"};request.post({url:url,form:params_3},function(error,res,body){if(error){return;}console.log(body);});}// Start From Step 1getLoginToken();

MediaWiki JS

/*upload_file_from_url.jsMediaWiki API DemosDemo of `Upload` module: Post request to upload a file from a URLMIT License*/varparams={action:'upload',filename:'New_image.jpg',url:'https://farm9.staticflickr.com/8213/8300206113_374c017fc5.jpg',ignorewarnings:'1',format:'json'},api=newmw.Api();api.postWithToken('csrf',params).done(function(data){console.log(data);});

Python

"""    upload_file_in_chunks.py    MediaWiki API Demos    Demo of `Upload` module: Step-by-step process to upload a file in chunks    MIT license"""importosimportrequestsS=requests.Session()URL="https://test.wikipedia.org/w/api.php"# File path of the image to be uploadedFILE_PATH='f.jpg'FILE=open(FILE_PATH,'rb')FILE_SIZE=os.stat(FILE_PATH).st_size# Bot credentialsBOT_USERNAME='enter_a_bot_username'BOT_PASSWORD='enter_a_bot_password'defread_chunks(file_object,chunk_size=5000):"""Return the next chunk of the file"""whileTrue:data=file_object.read(chunk_size)ifnotdata:breakyielddatadeffetch_login_token():"""Retrieve a login token"""params={"action":"query","meta":"tokens","type":"login","format":"json"}res=S.get(url=URL,params=params)data=res.json()returndata["query"]["tokens"]["logintoken"]defuser_login(login_token,username,password):"""Send a post request to login    Use of main account for login is not supported. Obtain credentials via    Special:BotPasswords (https://www.mediawiki.org/wiki/Special:BotPasswords)    for lgname & lgpassword """params={"action":"login","lgname":username,"lgpassword":password,"format":"json","lgtoken":login_token}S.post(URL,data=params)deffetch_csrf_token():"""While logged in, retrieve a CSRF token"""params={"action":"query","meta":"tokens","format":"json"}res=S.get(url=URL,params=params)data=res.json()returndata["query"]["tokens"]["csrftoken"]defupload_file_in_chunks(csrf_token):"""Send multiple post requests to upload a file in chunks using `stash` mode.    Stash mode is used to build a file up in pieces and then commit it at the end    """chunks=read_chunks(FILE)chunk=next(chunks)# Parameters for the first chunkparams={"action":"upload","stash":1,"filename":"chunk_test.jpg","filesize":FILE_SIZE,"offset":0,"format":"json","token":csrf_token,"ignorewarnings":1}index=0file={'chunk':('{}.jpg'.format(index),chunk,'multipart/form-data')}index+=1res=S.post(URL,files=file,data=params)data=res.json()# Pass the filekey parameter for second and further chunksforchunkinchunks:params={"action":"upload","stash":1,"offset":data["upload"]["offset"],"filename":"chunk_test.jpg","filesize":FILE_SIZE,"filekey":data["upload"]["filekey"],"format":"json","token":csrf_token,"ignorewarnings":1}file={'chunk':('{}.jpg'.format(index),chunk,'multipart/form-data')}index+=1res=S.post(URL,files=file,data=params)data=res.json()# Final upload using the filekey to commit the upload out of the stash areaparams={"action":"upload","filename":"chunk_test.jpg","filekey":data["upload"]["filekey"],"format":"json","comment":"Upload Testing","token":csrf_token,}res=S.post(URL,data=params)data=res.json()defmain():""" Four-step process to uploading a file in chunks"""login_token=fetch_login_token()# Step 1: Fetch login tokenuser_login(login_token,BOT_USERNAME,BOT_PASSWORD)# Step 2: Logincsrf_token=fetch_csrf_token()# Step 3: Fetch CSRF tokenupload_file_in_chunks(csrf_token)# Step 3: Upload a file in chunksif__name__=="__main__":main()

JavaScript

/*    upload_file_in_chunks.js    MediaWiki API Demos    Demo of `Upload` module: Step-by-step process to upload a file in chunks    MIT license*/varfs=require('fs'),request=require('request').defaults({jar:true}),url="http://dev.wiki.local.wmftest.net:8080/w/api.php",filename="My.jpg";// Step 1: GET request to fetch login tokenfunctiongetLoginToken(){varparams_0={action:"query",meta:"tokens",type:"login",format:"json"};request.get({url:url,qs:params_0},function(error,res,body){if(error){return;}vardata=JSON.parse(body);loginRequest(data.query.tokens.logintoken);});}// Step 2: POST request to log in.// Use of main account for login is not// supported. Obtain credentials via Special:BotPasswords// (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpasswordfunctionloginRequest(login_token){varparams_1={action:"login",lgname:"bot_username",lgpassword:"bot_password",lgtoken:login_token,format:"json"};request.post({url:url,form:params_1},function(error,res,body){if(error){return;}getCsrfToken();});}// Step 3: GET request to fetch CSRF tokenfunctiongetCsrfToken(){varparams_2={action:"query",meta:"tokens",format:"json"};request.get({url:url,qs:params_2},function(error,res,body){if(error){return;}vardata=JSON.parse(body);upload(data.query.tokens.csrftoken);});}// Step 4: POST request to upload a filefunctionupload(csrf_token){/*        Send multiple post requests to upload a file in chunks using `stash` mode.        Stash mode is used to build a file up in pieces and then commit it at the end    */varfileSizeInBytes=fs.statSync(filename).size;varheaders={"Content-Type":"multipart/form-data"};varparams_3={action:"upload",stash:"1",filename:"Sandboxfile1.jpg",filesize:fileSizeInBytes,offset:"0",ignorewarnings:"1",token:csrf_token,format:"json"};varfile={file:fs.createReadStream(filename)};varformData=Object.assign({},params_3,file);request.post({url:url,headers:headers,formData:formData},function(error,res,body){body=JSON.parse(body);if(error){return;}params_4={action:"upload",filename:"Sandboxfile1.jpg",filekey:body.upload.filekey,comment:"Upload Testing",token:csrf_token,format:"json"};request.post({url:url,form:params_4},function(error,res,body){body=JSON.parse(body);if(error){return;}console.log(body.upload.result);});});}// Start From Step 1getLoginToken();

MediaWiki JS

/*    upload_file_in_chunks.js    MediaWiki API Demos    Demo of `Upload` module: Step-by-step process to upload a file in chunks    MIT license*/varparam={filename:'TestFile_2.jpg',format:'json',ignorewarnings:1},fileInput=$('<input/>').attr('type','file'),submitBtn=$('<input/>').attr('type','button').attr('value','Upload'),api=newmw.Api();$('#bodyContent').append([fileInput,submitBtn]);$(submitBtn).on('click',function(){api.uploadToStash(fileInput[0],param).done(function(finish){finish(param).done(function(data){console.log(data.upload.filename+' has sucessfully uploaded.');}).fail(function(data){console.log(data);});});});