Body Parameters

Body

file

REQUIRED

Indicates that the content of the file is being sent as the request body

Key

string

REQUIRED

The key or name under which the object will be stored

ContentType

string

REQUIRED

Indicates the content type of the object being uploaded. Possible values include application/pdf, audio/mpeg, image/jpeg, image/png, or text/plain

Returns

requestid

string

Represents the ID of the request

status

string

Describes the status of the uploaded object

created

string

Specifies the date and time when the uploaded object was created

pin

object

The details of the uploaded object

cid

string

Represents the CID associated with the uploaded object

name

string

Specifies the name associated with the uploaded object

origins

array

A list of string values representing the origins of the uploaded object

meta

object

Contains details about the meta information of the uploaded object

info

object

The additional information about the uploaded object

size

string

Represents the size of the uploaded object

delegates

string

An array having information about delegates or additional parties involved in the upload process

Request

1
curl --location 'https://api.quicknode.com/ipfs/rest/v1/s3/put-object' \
2
--header 'x-api-key: YOUR_API_KEY' \
3
--form 'Body=@"YOUR_FILE_PATH"' \
4
--form 'Key="YOUR_FILE_NAME"' \
5
--form 'ContentType="YOUR_CONTENT_TYPE"'

1
curl --location 'https://api.quicknode.com/ipfs/rest/v1/s3/put-object' \
2
--header 'x-api-key: YOUR_API_KEY' \
3
--form 'Body=@"YOUR_FILE_PATH"' \
4
--form 'Key="YOUR_FILE_NAME"' \
5
--form 'ContentType="YOUR_CONTENT_TYPE"'

1
var myHeaders = new Headers();
2
myHeaders.append("x-api-key", "YOUR_API_KEY");
3

4
var formdata = new FormData();
5
formdata.append("Body", fileInput.files[0], "YOUR_FILE_PATH");
6
formdata.append("Key", "YOUR_FILE_NAME");
7
formdata.append("ContentType", "YOUR_CONTENT_TYPE");
8

9
var requestOptions = {
10
  method: 'POST',
11
  headers: myHeaders,
12
  body: formdata,
13
  redirect: 'follow'
14
};
15

16
fetch("https://api.quicknode.com/ipfs/rest/v1/s3/put-object", requestOptions)
17
  .then(response => response.text())
18
  .then(result => console.log(result))
19
  .catch(error => console.log('error', error));
20

1
var myHeaders = new Headers();
2
myHeaders.append("x-api-key", "YOUR_API_KEY");
3

4
var formdata = new FormData();
5
formdata.append("Body", fileInput.files[0], "YOUR_FILE_PATH");
6
formdata.append("Key", "YOUR_FILE_NAME");
7
formdata.append("ContentType", "YOUR_CONTENT_TYPE");
8

9
var requestOptions = {
10
  method: 'POST',
11
  headers: myHeaders,
12
  body: formdata,
13
  redirect: 'follow'
14
};
15

16
fetch("https://api.quicknode.com/ipfs/rest/v1/s3/put-object", requestOptions)
17
  .then(response => response.text())
18
  .then(result => console.log(result))
19
  .catch(error => console.log('error', error));
20

1
import requests
2

3
url = "https://api.quicknode.com/ipfs/rest/v1/s3/put-object"
4

5
payload = {'Key': 'YOUR_FILE_NAME',
6
'ContentType': 'YOUR_CONTENT_TYPE'}
7
files=[
8
  ('Body',('YOUR_FILE_NAME',open('YOUR_FILE_PATH','rb'),'YOUR_CONTENT_TYPE'))
9
]
10
headers = {
11
  'x-api-key': 'YOUR_API_KEY'
12
}
13

14
response = requests.request("POST", url, headers=headers, data=payload, files=files)
15

16
print(response.text)
17

1
import requests
2

3
url = "https://api.quicknode.com/ipfs/rest/v1/s3/put-object"
4

5
payload = {'Key': 'YOUR_FILE_NAME',
6
'ContentType': 'YOUR_CONTENT_TYPE'}
7
files=[
8
  ('Body',('YOUR_FILE_NAME',open('YOUR_FILE_PATH','rb'),'YOUR_CONTENT_TYPE'))
9
]
10
headers = {
11
  'x-api-key': 'YOUR_API_KEY'
12
}
13

14
response = requests.request("POST", url, headers=headers, data=payload, files=files)
15

16
print(response.text)
17

1
require "uri"
2
require "net/http"
3

4
url = URI("https://api.quicknode.com/ipfs/rest/v1/s3/put-object")
5

6
https = Net::HTTP.new(url.host, url.port)
7
https.use_ssl = true
8

9
request = Net::HTTP::Post.new(url)
10
request["x-api-key"] = "YOUR_API_KEY"
11
form_data = [['Body', File.open('YOUR_FILE_PATH')],['Key', 'YOUR_FILE_NAME'],['ContentType', 'YOUR_CONTENT_TYPE']]
12
request.set_form form_data, 'multipart/form-data'
13
response = https.request(request)
14
puts response.read_body
15

1
require "uri"
2
require "net/http"
3

4
url = URI("https://api.quicknode.com/ipfs/rest/v1/s3/put-object")
5

6
https = Net::HTTP.new(url.host, url.port)
7
https.use_ssl = true
8

9
request = Net::HTTP::Post.new(url)
10
request["x-api-key"] = "YOUR_API_KEY"
11
form_data = [['Body', File.open('YOUR_FILE_PATH')],['Key', 'YOUR_FILE_NAME'],['ContentType', 'YOUR_CONTENT_TYPE']]
12
request.set_form form_data, 'multipart/form-data'
13
response = https.request(request)
14
puts response.read_body
15

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free