Endpoints List RESTful API

The Defactor Postman Collection comprises a suite of pre-configured API requests designed for seamless integration into the Postman application, facilitating access to the services offered by the Defactor API.

This API offers dual modes of interaction with the IPFS node: firstly, via the RESTful API; and secondly, through the GraphQL API.

---

Security Details

To secure the API access control, all requests are made through Hasura which provides secure GraphQL, and RESTful endpoints restricted by a role-based authorization system.

Those endpoints that return public data do not require authentication for use. Query type requests are opened under the guest role, while mutation type needs a token with admin role.

For those that can modify data the API expects a valid authorization header containing a bearer token. These tokens are implemented as JSON Web Tokens (JWTs) issued by the server.

The security of the JWT is because it is signed by a secret key and has a configurable expiration time, which by default is 60 minutes.

Upon receiving a request, Hasura decodes and validates the JWT, which contains user account data, and their corresponding role. If the role lacks the necessary permissions or the token is invalid, expired or missing, the request is promptly rejected.

IPFS

Interact with a private IPFS node to upload and retrieve files. Interact with a private IPFS node to upload and retrieve files. Since GraphQL operates with JSON payloads and responses, binary data needs to be represented as a string. This API supports both byte arrays (bytea) and base64-encoded strings.

Upload File

Upload a file to the private IPFS node. The endpoint expects a string with a byte array, for example: [130, 20, 8] or a base64 encoded string. In other words, the binary data in the file must be encoded in any of these string formats.

The response CID hash and file type must then be stored so that the file can be retrieved and reconstructed correctly.

HTTP Request Method: POST

Roles: Admin

Request URL: {{BASE_RESTFUL_URL}}/v1/ipfs/upload-file

Request Body

{
  "file": "<svg width="228" height="44" viewBox="0 0 228 44" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M39.9384 0.0332316L22.883 1.4882C20.9617 1.65212 19.9337 3.88983 21.0325 5.51608L30.7873 19.9516C31.8861 21.5779 34.2882 21.3734 35.1099 19.5833L42.4105 3.69276C43.233 1.90167 41.8597 -0.130683 39.9384 0.0332316Z" fill="#D21A4D"/>
<path d="M0.0283517 2.78764L1.4456 20.297C1.60526 22.2695 3.78495 23.3248 5.36903 22.1968L19.4302 12.1823C21.0143 11.0543 20.8152 8.58818 19.0714 7.74467L3.59299 0.249722C1.84835 -0.594713 -0.131313 0.815138 0.0283517 2.78764Z" fill="#5A5BEB"/>
<path d="M2.71535 43.757L19.7707 42.302C21.6921 42.1381 22.72 39.9004 21.6212 38.2742L11.8664 23.8386C10.7676 22.2124 8.36549 22.4168 7.54385 24.207L0.243247 40.0975C-0.579292 41.8886 0.794 43.9209 2.71535 43.757Z" fill="#E0A225"/>
<path d="M42.6394 40.9862L41.2221 23.4768C41.0625 21.5043 38.8828 20.449 37.2987 21.5771L23.2366 31.5915C21.6525 32.7196 21.8516 35.1857 23.5954 36.0292L39.0739 43.5241C40.8185 44.3686 42.7982 42.9587 42.6394 40.9862Z" fill="#26A66B"/>
<path d="M66.9608 37.4085C64.93 37.4085 63.1172 36.9021 61.5223 35.89C59.9266 34.878 58.6654 33.493 57.737 31.736C56.8087 29.9799 56.3449 27.9844 56.3449 25.7504C56.3449 23.5173 56.8087 21.5291 57.737 19.7877C58.6654 18.0455 59.9266 16.6761 61.5223 15.6779C63.1172 14.6806 64.9309 14.1815 66.9608 14.1815C68.5852 14.1815 70.0061 14.4946 71.2242 15.1199C72.4423 15.7451 73.4281 16.6236 74.1825 17.7554V5.30249H79.7519L79.881 37.4085H74.9207L74.1834 33.7011C73.4873 34.6837 72.5661 35.5475 71.4206 36.2915C70.2743 37.0356 68.788 37.4085 66.9608 37.4085ZM68.1358 32.4055C69.9343 32.4055 71.4054 31.7876 72.5517 30.5518C73.6972 29.3169 74.2704 27.7302 74.2704 25.7946C74.2704 23.8589 73.6972 22.2732 72.5517 21.0374C71.4054 19.8016 69.9334 19.1837 68.1358 19.1837C66.3661 19.1837 64.9013 19.7942 63.7415 21.0143C62.5808 22.2363 62.0013 23.8138 62.0013 25.7494C62.0013 27.686 62.5817 29.2782 63.7415 30.5287C64.9013 31.7802 66.3661 32.4055 68.1358 32.4055Z" fill="black"/>
<path d="M93.9188 37.4085C91.7436 37.4085 89.8142 36.9315 88.1323 35.9793C86.4496 35.0262 85.1301 33.6864 84.173 31.9597C83.2159 30.2331 82.7369 28.2376 82.7369 25.9741C82.7369 23.6811 83.2079 21.6414 84.1506 19.8549C85.0924 18.0684 86.3984 16.6761 88.0668 15.6788C89.7344 14.6815 91.6997 14.1824 93.9628 14.1824C96.0797 14.1824 97.9508 14.6594 99.5752 15.6116C101.2 16.5647 102.469 17.8677 103.382 19.5197C104.295 21.1718 104.753 23.0117 104.753 25.0357C104.753 25.3636 104.745 25.7061 104.731 26.0634C104.716 26.4207 104.694 26.7937 104.666 27.1804H88.2633C88.379 28.908 88.9665 30.2626 90.025 31.2451C91.0834 32.2277 92.367 32.7194 93.8758 32.7194C95.0069 32.7194 95.9568 32.4588 96.7255 31.9376C97.4933 31.4173 98.0665 30.7396 98.4441 29.9053H104.101C103.694 31.305 103.02 32.5786 102.078 33.7241C101.135 34.8706 99.9744 35.7721 98.5975 36.4269C97.2179 37.0807 95.659 37.4085 93.9188 37.4085ZM93.9619 18.8272C92.5984 18.8272 91.3947 19.2223 90.3506 20.0105C89.3065 20.7997 88.6391 21.9987 88.3494 23.6065H99.0962C99.0092 22.1479 98.4872 20.9867 97.5301 20.122C96.573 19.2591 95.3827 18.8272 93.9619 18.8272Z" fill="black"/>
<path d="M110.567 37.4084V20.0326H107.608V15.2533H110.567V12.6629C110.567 9.98315 111.226 8.07788 112.546 6.94521C113.866 5.81438 115.657 5.24805 117.92 5.24805H120.313V10.1167H118.79C117.833 10.1167 117.151 10.311 116.745 10.6977C116.339 11.0845 116.136 11.7402 116.136 12.6629V15.2533H120.791V20.0326H116.136V37.4084H110.567Z" fill="black"/>
<path d="M131.739 37.4086C129.882 37.4086 128.359 37.1029 127.171 36.4924C125.981 35.8828 125.097 35.0706 124.516 34.0585C123.936 33.0465 123.646 31.9304 123.646 30.7084C123.646 28.6539 124.429 26.9863 125.996 25.7062C127.562 24.4262 129.912 23.7853 133.044 23.7853H138.527V23.2494C138.527 21.7309 138.106 20.6138 137.265 19.8993C136.424 19.1847 135.379 18.8274 134.132 18.8274C133.001 18.8274 132.014 19.1027 131.174 19.6534C130.333 20.205 129.81 21.0153 129.608 22.0872H124.169C124.314 20.4794 124.844 19.0797 125.757 17.8881C126.671 16.6974 127.852 15.7821 129.303 15.1411C130.753 14.5011 132.377 14.1807 134.176 14.1807C137.25 14.1807 139.672 14.9698 141.442 16.5482C143.211 18.1266 144.096 20.3597 144.096 23.2485V37.2595H139.354L138.832 33.2979C138.193 34.4895 137.301 35.4721 136.156 36.2456C135.009 37.021 133.537 37.4086 131.739 37.4086ZM133 32.9415C134.595 32.9415 135.835 32.4056 136.72 31.3328C137.604 30.2609 138.162 28.9367 138.395 27.3574H133.652C132.173 27.3574 131.114 27.6327 130.476 28.1834C129.838 28.735 129.519 29.4118 129.519 30.2157C129.519 31.0795 129.838 31.7499 130.476 32.226C131.115 32.7039 131.956 32.9415 133 32.9415Z" fill="black"/>
<path d="M158.219 37.4085C156.014 37.4085 154.07 36.9177 152.388 35.9342C150.705 34.9516 149.379 33.5823 148.407 31.8253C147.435 30.0683 146.95 28.058 146.95 25.7954C146.95 23.5329 147.435 21.5226 148.407 19.7656C149.379 18.0095 150.705 16.6393 152.388 15.6567C154.07 14.6741 156.014 14.1824 158.219 14.1824C160.974 14.1824 163.294 14.9191 165.18 16.3934C167.065 17.8677 168.269 19.9 168.791 22.4904H162.918C162.627 21.4186 162.054 20.5769 161.199 19.9663C160.344 19.3567 159.335 19.051 158.176 19.051C156.638 19.051 155.332 19.6468 154.259 20.8375C153.186 22.0282 152.649 23.6811 152.649 25.7954C152.649 27.9098 153.186 29.5627 154.259 30.7534C155.332 31.945 156.638 32.5399 158.176 32.5399C159.335 32.5399 160.344 32.2424 161.199 31.6466C162.054 31.0518 162.627 30.2027 162.918 29.1004H168.791C168.269 31.6015 167.065 33.6118 165.18 35.1303C163.294 36.6488 160.974 37.4085 158.219 37.4085Z" fill="black"/>
<path d="M182.828 37.4084C180.565 37.4084 178.752 36.843 177.389 35.7113C176.026 34.5804 175.344 32.5702 175.344 29.6814V20.0326H171.647V15.2533H175.344L175.997 9.31274H180.914V15.2533H186.743V20.0326H180.914V29.7256C180.914 30.7975 181.138 31.5351 181.588 31.9366C182.037 32.339 182.813 32.5398 183.916 32.5398H186.613V37.4084H182.828Z" fill="black"/>
<path d="M200.65 37.4086C198.561 37.4086 196.682 36.9178 195.015 35.9343C193.347 34.9518 192.027 33.5889 191.056 31.8475C190.084 30.1052 189.599 28.0885 189.599 25.7947C189.599 23.5017 190.091 21.4841 191.078 19.7418C192.064 17.9995 193.39 16.6375 195.06 15.655C196.727 14.6724 198.605 14.1807 200.694 14.1807C202.752 14.1807 204.616 14.6715 206.285 15.655C207.952 16.6375 209.272 17.9995 210.244 19.7418C211.215 21.4841 211.701 23.5017 211.701 25.7947C211.701 28.0885 211.215 30.1052 210.244 31.8475C209.272 33.5898 207.945 34.9518 206.262 35.9343C204.579 36.9178 202.708 37.4086 200.65 37.4086ZM200.65 32.4507C202.099 32.4507 203.361 31.8926 204.435 30.7756C205.508 29.6586 206.045 27.9992 206.045 25.7956C206.045 23.5919 205.508 21.9316 204.435 20.8155C203.361 19.6985 202.114 19.1405 200.693 19.1405C199.214 19.1405 197.943 19.6985 196.885 20.8155C195.826 21.9325 195.297 23.5919 195.297 25.7956C195.297 27.9992 195.826 29.6595 196.885 30.7756C197.944 31.8926 199.198 32.4507 200.65 32.4507Z" fill="black"/>
<path d="M214.556 37.4084V15.2532H219.516L220.038 19.4073C220.821 17.9781 221.887 16.839 223.236 15.9908C224.585 15.1418 226.173 14.7173 228 14.7173V20.7471H226.434C225.216 20.7471 224.128 20.9414 223.171 21.3273C222.214 21.715 221.466 22.3844 220.93 23.3375C220.393 24.2915 220.125 25.6158 220.125 27.3129V37.4075L214.556 37.4084Z" fill="black"/>
</svg>
"
}

Response

Upon successful completion of a request, the server will issue a status code of 200 along with a JSON object encapsulating the hash. This object encompasses the following attributes:

{
  "v1UploadFile": {
    "res": {
      "hash": "QmPktZrLGnHZSAU3WVNYFZ4V7JUqi16yhK3eiCht4nECsp"
    },
    "success": true
  }
}

info

In the previous example an xml file with an svg was uploaded, so in a database it's necessary to store the hash of the response and that the file is an xml.

Get File

Retrieve a file from the private IPFS node using the CID hash. The response must be processed to retrieve the data from the file. In the res property is the data that must be used to rebuild the file.

The encoding parameter determines how the data response is encoded, it could be a base64 string or a byte array, for example: [130, 20, 8]. It's important to know the type of file to build it correctly.

Property	Description
hash	The content identifier CID in version 0 or 1
encoding	One of the following values: bytea, base64. Default: bytea

HTTP Request Method: POST

Roles: Admin

Request URL: {{BASE_RESTFUL_URL}}/v1/ipfs/get-file

Request Body

{
  "hash": "QmPktZrLGnHZSAU3WVNYFZ4V7JUqi16yhK3eiCht4nECsp",
  "encoding": "base64"
}

Response

Upon successful completion of a request, the server will issue a status code of 200 along with a JSON object encapsulating the file. This object encompasses the following attributes:

{
  "v1GetFile": {
"res": "<svg width="228" height="44" viewBox="0 0 228 44" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M39.9384 0.0332316L22.883 1.4882C20.9617 1.65212 19.9337 3.88983 21.0325 5.51608L30.7873 19.9516C31.8861 21.5779 34.2882 21.3734 35.1099 19.5833L42.4105 3.69276C43.233 1.90167 41.8597 -0.130683 39.9384 0.0332316Z" fill="#D21A4D"/>
<path d="M0.0283517 2.78764L1.4456 20.297C1.60526 22.2695 3.78495 23.3248 5.36903 22.1968L19.4302 12.1823C21.0143 11.0543 20.8152 8.58818 19.0714 7.74467L3.59299 0.249722C1.84835 -0.594713 -0.131313 0.815138 0.0283517 2.78764Z" fill="#5A5BEB"/>
<path d="M2.71535 43.757L19.7707 42.302C21.6921 42.1381 22.72 39.9004 21.6212 38.2742L11.8664 23.8386C10.7676 22.2124 8.36549 22.4168 7.54385 24.207L0.243247 40.0975C-0.579292 41.8886 0.794 43.9209 2.71535 43.757Z" fill="#E0A225"/>
<path d="M42.6394 40.9862L41.2221 23.4768C41.0625 21.5043 38.8828 20.449 37.2987 21.5771L23.2366 31.5915C21.6525 32.7196 21.8516 35.1857 23.5954 36.0292L39.0739 43.5241C40.8185 44.3686 42.7982 42.9587 42.6394 40.9862Z" fill="#26A66B"/>
<path d="M66.9608 37.4085C64.93 37.4085 63.1172 36.9021 61.5223 35.89C59.9266 34.878 58.6654 33.493 57.737 31.736C56.8087 29.9799 56.3449 27.9844 56.3449 25.7504C56.3449 23.5173 56.8087 21.5291 57.737 19.7877C58.6654 18.0455 59.9266 16.6761 61.5223 15.6779C63.1172 14.6806 64.9309 14.1815 66.9608 14.1815C68.5852 14.1815 70.0061 14.4946 71.2242 15.1199C72.4423 15.7451 73.4281 16.6236 74.1825 17.7554V5.30249H79.7519L79.881 37.4085H74.9207L74.1834 33.7011C73.4873 34.6837 72.5661 35.5475 71.4206 36.2915C70.2743 37.0356 68.788 37.4085 66.9608 37.4085ZM68.1358 32.4055C69.9343 32.4055 71.4054 31.7876 72.5517 30.5518C73.6972 29.3169 74.2704 27.7302 74.2704 25.7946C74.2704 23.8589 73.6972 22.2732 72.5517 21.0374C71.4054 19.8016 69.9334 19.1837 68.1358 19.1837C66.3661 19.1837 64.9013 19.7942 63.7415 21.0143C62.5808 22.2363 62.0013 23.8138 62.0013 25.7494C62.0013 27.686 62.5817 29.2782 63.7415 30.5287C64.9013 31.7802 66.3661 32.4055 68.1358 32.4055Z" fill="black"/>
<path d="M93.9188 37.4085C91.7436 37.4085 89.8142 36.9315 88.1323 35.9793C86.4496 35.0262 85.1301 33.6864 84.173 31.9597C83.2159 30.2331 82.7369 28.2376 82.7369 25.9741C82.7369 23.6811 83.2079 21.6414 84.1506 19.8549C85.0924 18.0684 86.3984 16.6761 88.0668 15.6788C89.7344 14.6815 91.6997 14.1824 93.9628 14.1824C96.0797 14.1824 97.9508 14.6594 99.5752 15.6116C101.2 16.5647 102.469 17.8677 103.382 19.5197C104.295 21.1718 104.753 23.0117 104.753 25.0357C104.753 25.3636 104.745 25.7061 104.731 26.0634C104.716 26.4207 104.694 26.7937 104.666 27.1804H88.2633C88.379 28.908 88.9665 30.2626 90.025 31.2451C91.0834 32.2277 92.367 32.7194 93.8758 32.7194C95.0069 32.7194 95.9568 32.4588 96.7255 31.9376C97.4933 31.4173 98.0665 30.7396 98.4441 29.9053H104.101C103.694 31.305 103.02 32.5786 102.078 33.7241C101.135 34.8706 99.9744 35.7721 98.5975 36.4269C97.2179 37.0807 95.659 37.4085 93.9188 37.4085ZM93.9619 18.8272C92.5984 18.8272 91.3947 19.2223 90.3506 20.0105C89.3065 20.7997 88.6391 21.9987 88.3494 23.6065H99.0962C99.0092 22.1479 98.4872 20.9867 97.5301 20.122C96.573 19.2591 95.3827 18.8272 93.9619 18.8272Z" fill="black"/>
<path d="M110.567 37.4084V20.0326H107.608V15.2533H110.567V12.6629C110.567 9.98315 111.226 8.07788 112.546 6.94521C113.866 5.81438 115.657 5.24805 117.92 5.24805H120.313V10.1167H118.79C117.833 10.1167 117.151 10.311 116.745 10.6977C116.339 11.0845 116.136 11.7402 116.136 12.6629V15.2533H120.791V20.0326H116.136V37.4084H110.567Z" fill="black"/>
<path d="M131.739 37.4086C129.882 37.4086 128.359 37.1029 127.171 36.4924C125.981 35.8828 125.097 35.0706 124.516 34.0585C123.936 33.0465 123.646 31.9304 123.646 30.7084C123.646 28.6539 124.429 26.9863 125.996 25.7062C127.562 24.4262 129.912 23.7853 133.044 23.7853H138.527V23.2494C138.527 21.7309 138.106 20.6138 137.265 19.8993C136.424 19.1847 135.379 18.8274 134.132 18.8274C133.001 18.8274 132.014 19.1027 131.174 19.6534C130.333 20.205 129.81 21.0153 129.608 22.0872H124.169C124.314 20.4794 124.844 19.0797 125.757 17.8881C126.671 16.6974 127.852 15.7821 129.303 15.1411C130.753 14.5011 132.377 14.1807 134.176 14.1807C137.25 14.1807 139.672 14.9698 141.442 16.5482C143.211 18.1266 144.096 20.3597 144.096 23.2485V37.2595H139.354L138.832 33.2979C138.193 34.4895 137.301 35.4721 136.156 36.2456C135.009 37.021 133.537 37.4086 131.739 37.4086ZM133 32.9415C134.595 32.9415 135.835 32.4056 136.72 31.3328C137.604 30.2609 138.162 28.9367 138.395 27.3574H133.652C132.173 27.3574 131.114 27.6327 130.476 28.1834C129.838 28.735 129.519 29.4118 129.519 30.2157C129.519 31.0795 129.838 31.7499 130.476 32.226C131.115 32.7039 131.956 32.9415 133 32.9415Z" fill="black"/>
<path d="M158.219 37.4085C156.014 37.4085 154.07 36.9177 152.388 35.9342C150.705 34.9516 149.379 33.5823 148.407 31.8253C147.435 30.0683 146.95 28.058 146.95 25.7954C146.95 23.5329 147.435 21.5226 148.407 19.7656C149.379 18.0095 150.705 16.6393 152.388 15.6567C154.07 14.6741 156.014 14.1824 158.219 14.1824C160.974 14.1824 163.294 14.9191 165.18 16.3934C167.065 17.8677 168.269 19.9 168.791 22.4904H162.918C162.627 21.4186 162.054 20.5769 161.199 19.9663C160.344 19.3567 159.335 19.051 158.176 19.051C156.638 19.051 155.332 19.6468 154.259 20.8375C153.186 22.0282 152.649 23.6811 152.649 25.7954C152.649 27.9098 153.186 29.5627 154.259 30.7534C155.332 31.945 156.638 32.5399 158.176 32.5399C159.335 32.5399 160.344 32.2424 161.199 31.6466C162.054 31.0518 162.627 30.2027 162.918 29.1004H168.791C168.269 31.6015 167.065 33.6118 165.18 35.1303C163.294 36.6488 160.974 37.4085 158.219 37.4085Z" fill="black"/>
<path d="M182.828 37.4084C180.565 37.4084 178.752 36.843 177.389 35.7113C176.026 34.5804 175.344 32.5702 175.344 29.6814V20.0326H171.647V15.2533H175.344L175.997 9.31274H180.914V15.2533H186.743V20.0326H180.914V29.7256C180.914 30.7975 181.138 31.5351 181.588 31.9366C182.037 32.339 182.813 32.5398 183.916 32.5398H186.613V37.4084H182.828Z" fill="black"/>
<path d="M200.65 37.4086C198.561 37.4086 196.682 36.9178 195.015 35.9343C193.347 34.9518 192.027 33.5889 191.056 31.8475C190.084 30.1052 189.599 28.0885 189.599 25.7947C189.599 23.5017 190.091 21.4841 191.078 19.7418C192.064 17.9995 193.39 16.6375 195.06 15.655C196.727 14.6724 198.605 14.1807 200.694 14.1807C202.752 14.1807 204.616 14.6715 206.285 15.655C207.952 16.6375 209.272 17.9995 210.244 19.7418C211.215 21.4841 211.701 23.5017 211.701 25.7947C211.701 28.0885 211.215 30.1052 210.244 31.8475C209.272 33.5898 207.945 34.9518 206.262 35.9343C204.579 36.9178 202.708 37.4086 200.65 37.4086ZM200.65 32.4507C202.099 32.4507 203.361 31.8926 204.435 30.7756C205.508 29.6586 206.045 27.9992 206.045 25.7956C206.045 23.5919 205.508 21.9316 204.435 20.8155C203.361 19.6985 202.114 19.1405 200.693 19.1405C199.214 19.1405 197.943 19.6985 196.885 20.8155C195.826 21.9325 195.297 23.5919 195.297 25.7956C195.297 27.9992 195.826 29.6595 196.885 30.7756C197.944 31.8926 199.198 32.4507 200.65 32.4507Z" fill="black"/>
<path d="M214.556 37.4084V15.2532H219.516L220.038 19.4073C220.821 17.9781 221.887 16.839 223.236 15.9908C224.585 15.1418 226.173 14.7173 228 14.7173V20.7471H226.434C225.216 20.7471 224.128 20.9414 223.171 21.3273C222.214 21.715 221.466 22.3844 220.93 23.3375C220.393 24.2915 220.125 25.6158 220.125 27.3129V37.4075L214.556 37.4084Z" fill="black"/>
</svg>
"
    "success": true
  }
}

Error Reference

Error Response Format

The errors have the GraphQL error schema, an object with an errors array property where each item has the following schema:

Property	Description
message	The description of the error
extensions	An object with the path to the field that caused the error, and the error code

Examples

The variable has a wrong type:

{
  "errors": [
    {
      "message": "expected a string for type 'String', but found a number",
      "extensions": {
        "path": "$.selectionSet.v1UploadFile.args.file",
        "code": "validation-failed"
      }
    }
  ]
}

The variable is missing in the request body:

{
  "errors": [
    {
      "message": "missing required field 'hash'",
      "extensions": {
        "path": "$.selectionSet.v1GetFile.args.hash",
        "code": "validation-failed"
      }
    }
  ]
}

The field does not exists or the role has no permissions:

{
  "errors": [
    {
      "message": "field 'v1UploadFile' not found in type: 'mutation_root'",
      "extensions": {
        "path": "$.selectionSet.v1UploadFile",
        "code": "validation-failed"
      }
    }
  ]
}

The variable is not in the request body schema:

{
  "errors": [
    {
      "message": "Unexpected variable data",
      "extensions": {
        "path": "$",
        "code": "bad-request"
      }
    }
  ]
}

The GraphQL variables object is not a valid json:

{
  "errors": [
    {
      "message": "Error in $: Failed reading: satisfy. Expecting object value at X",
      "extensions": {
        "path": "$",
        "code": "invalid-json"
      }
    }
  ]
}

The endpoint does not exists:

{
  "errors": [
    {
      "message": "Endpoint not found",
      "extensions": {
        "path": "$",
        "code": "not-found"
      }
    }
  ]
}

Error processing the request:

{
  "errors": [
    {
      "message": "The hash is an invalid CID",
      "extensions": {
        "path": "$",
        "code": "unexpected"
      }
    }
  ]
}

Types of Error

General

Error Message	Reason
Could not verify JWT: JWT error	The JWT is invalid
Invalid request payload input	The data format is not as expected.

IPFS

Error Message	Reason
An error occurred while interacting with the ipfs endpoint	An error occurs on the server
The hash is an invalid CID	The provided string is not a content identifier.
The IPFS file with the hash "hash" cannot be found	The file does not exist or the IPFS node failed