/intake

Upload records from an Everloot SavedVariables file

POSThttps://everloot.app/api/intake

One envelope of at most 2,000 records and 1 MB. Every record is checked against its kind's schema; the receipt lists what was accepted and what was rejected and why. Named categories need the matching sharing choice and a verified grant. Anonymous, keyed by a random install id; quotas per request and per install.

Access#

Open to anyone, limited per IP address. Data: no data. Limits and keys are explained on Limits and keys.

Request body#

JSON of the intakeRequest shape. The Desktop App and the upload page send it for you.

Responses#

200intakeReceipt: Stored.
400intakeRefused: The body is not JSON, or the grants are malformed.
413intakeRefused: The body is over 1 MB.
422intakeRefused: The envelope or every record was refused; the receipt says why.
429intakeRefused: Rate limited; keep the file and retry after Retry-After.
503intakeRefused: Storage could not confirm the write; keep the file and retry.

Response fields#

The top-level fields of a successful answer. Full shapes are on Schemas and in the OpenAPI document.

okexactly truerequired: No description.
persistedexactly truerequired: No description.
uploadIdstringrequired: No description.
acceptedarray of objectsrequired: No description.
rejectedarray of objectsrequired: No description.

Request

curl --request POST "https://everloot.app/api/intake" \
  --header "content-type: application/json" \
  --data @upload.json

const body = await readFile("upload.json", "utf8");
const res = await fetch("https://everloot.app/api/intake", {
  method: "POST",
  headers: { "content-type": "application/json" },
  body,
});
console.log(await res.json());

import requests

with open("upload.json", "rb") as f:
    res = requests.post("https://everloot.app/api/intake", data=f, headers={"content-type": "application/json"})
print(res.json())

Response

{
  "ok": true,
  "persisted": true,
  "uploadId": "string",
  "accepted": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ],
  "rejected": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ]
}

{
  "ok": false,
  "error": "string",
  "persisted": false,
  "uploadId": "string",
  "accepted": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ],
  "rejected": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ]
}

{
  "ok": false,
  "error": "string",
  "persisted": false,
  "uploadId": "string",
  "accepted": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ],
  "rejected": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ]
}

{
  "ok": false,
  "error": "string",
  "persisted": false,
  "uploadId": "string",
  "accepted": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ],
  "rejected": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ]
}

{
  "ok": false,
  "error": "string",
  "persisted": false,
  "uploadId": "string",
  "accepted": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ],
  "rejected": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ]
}

{
  "ok": false,
  "error": "string",
  "persisted": false,
  "uploadId": "string",
  "accepted": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ],
  "rejected": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ]
}

Example values show the shape of an answer, not real data.

Request

curl --request POST "https://everloot.app/api/intake" \
  --header "content-type: application/json" \
  --data @upload.json

const body = await readFile("upload.json", "utf8");
const res = await fetch("https://everloot.app/api/intake", {
  method: "POST",
  headers: { "content-type": "application/json" },
  body,
});
console.log(await res.json());

import requests

with open("upload.json", "rb") as f:
    res = requests.post("https://everloot.app/api/intake", data=f, headers={"content-type": "application/json"})
print(res.json())

Response

{
  "ok": true,
  "persisted": true,
  "uploadId": "string",
  "accepted": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ],
  "rejected": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ]
}

{
  "ok": false,
  "error": "string",
  "persisted": false,
  "uploadId": "string",
  "accepted": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ],
  "rejected": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ]
}

{
  "ok": false,
  "error": "string",
  "persisted": false,
  "uploadId": "string",
  "accepted": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ],
  "rejected": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ]
}

{
  "ok": false,
  "error": "string",
  "persisted": false,
  "uploadId": "string",
  "accepted": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ],
  "rejected": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ]
}

{
  "ok": false,
  "error": "string",
  "persisted": false,
  "uploadId": "string",
  "accepted": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ],
  "rejected": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ]
}

{
  "ok": false,
  "error": "string",
  "persisted": false,
  "uploadId": "string",
  "accepted": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ],
  "rejected": [
    {
      "index": 0,
      "kind": "string",
      "reason": "string"
    }
  ]
}

Example values show the shape of an answer, not real data.