GET https://api.orbitkit.com/designs

Retrieves a complete list of all of your designs. The result will be encapsulated in an object like this:

{ "data": [ {...first...}, {...second...} ] }

The data will be the same data in the GET single design endpoint below.

GET https://api.orbitkit.com/designs/DES123

Obtain the data for a single design with key DES123. Response looks like:

{
  "key": "DES123",
  "art": "https://storage.googleapis.com/orbitkit/1234-56789",
  "filename": "yourfile.png",
  "batch": "2019-02-05T19:37:45.123Z",
  "translations": [
    {
      "language": "en",
      "title": "Cool Design",
      "description": "It's really cool",
      "tags": ["very","cool"]
    },
    { ...de... },
    {...es...},
    {...fr...}
  ],
  "note": "My private note"
}

Requests for invalid keys produce 410 GONE (to explicitly distinguish from 404).

POST https://api.orbitkit.com/designs

Imports a design into OrbitKit, optionally updating the design if it already exists. The POST body should include the following JSON:

{
  "art": "http://example.com/your/image_file.png",
  "filename": "image_file.png",
  "batch": "2019-02-05T19:37:45.123Z",
  "translations": [
    {
      "language": "en",
      "title": "Cool Design",
      "description": "It's really cool",
      "tags": ["very","cool"]
    },
    "note": "My private note about this design",
    "update": false
  ]
}

  • art can be any public URL to a jpg or png image
  • filename if absent, will be inferred from the URL 
  • batch should be an ISO8601 date in UTC, including millisecond precision. If you want multiple designs to be in the same batch, provide the exact same value for each. Batches are just timestamps.
  • translations are the design metadata in zero or more languages. The currently allowed languages are en, de, fr, and es.
  • note is a bit of private information from, and for, you.
  • update determines whether filename & note & translations should be updated when a duplicate upload is detected. If false, a duplicate upload is completely ignored. "Duplicate" is determined by a byte-for-byte comparison of the image.
  • tags order is irrelevant here. To set tag order (which is global to all of your designs), post to the /tags endpoint. You can reorder tags before or after you post designs, it makes no difference.

The response will be the actual design data on file (see GET /designs/DES123 below).

OrbitKit only stores one copy of each design image. If you try to upload a duplicate image, OrbitKit will ignore the duplicate and return success (200 OK) with the original design data JSON.

Did this answer your question?