Get StartedDaruma Formats
Daruma API

Overview

Quick Start

API Reference

Get all Darumas

GET

Get a Daruma

GET

Create a Daruma

POST

Delete a Daruma

DELETE

Convert a design file

POST

Get all conversion statuses

GET

Get a conversion status

GET

Get the original file

GET

Get last conversion status

GET

Get the Daruma file

GET

Get the daruma design data

GET

Get rendered images

GET
Daruma SDK

API Reference

Get all Darumas

Get all the darumas of a specific user.

GET/api/daruma/all
Example
cURL
bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/all' \ 
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Responses
200
[
  {
    "createdAt": "2023-09-28T10:47:39.688Z",
    "updatedAt": "2023-09-28T10:47:39.688Z",
    "id": "string",
    "name": "string",
    "userId": "string",
    "darumaImports": [
      {
        "createdAt": "2023-09-28T10:47:39.688Z",
        "updatedAt": "2023-09-28T10:47:39.688Z",
        "id": "string",
        "uri": "string",
        "darumaId": "string",
        "finished": "boolean"
      }
    ],
    "taskStatus": {
      "parse": "boolean",
      "render": "boolean"
    }
  }
]

Get a Daruma

Get a specific daruma.

GET/api/daruma/get/daruma/{darumaid}
Example
cURL
bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/get/daruma/{darumaid}' \ 
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Request

Path Parameters

darumaidstringrequired
Responses
200
{
  "createdAt": "2023-09-28T10:47:39.688Z",
  "updatedAt": "2023-09-28T10:47:39.688Z",
  "id": "string",
  "name": "string",
  "userId": "string",
  "darumaImports": [
    {
      "createdAt": "2023-09-28T10:47:39.688Z",
      "updatedAt": "2023-09-28T10:47:39.688Z",
      "id": "string",
      "uri": "string",
      "darumaId": "string",
      "finished": "boolean"
    }
  ],
  "taskStatus": {
    "parse": "boolean",
    "render": "boolean"
  }
}

Create a Daruma

Create a daruma and generate the url for uploading a design file.

POST/api/daruma/import/file
Example
cURL
bash
curl -X POST 'https://verygoodgraphics.com/api/daruma/import/file' \ 
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"'' \ 
  -H "Content-Type: application/json" \ 
  --data '{"filename":"string","darumaId":"string"}'
Request

RequestBody

filenamestringrequired
darumaIdstringrequired
Responses
200
{
  "darumaImport": {
    "createdAt": "2023-09-28T10:47:39.689Z",
    "updatedAt": "2023-09-28T10:47:39.689Z",
    "id": "string",
    "uri": "string",
    "darumaId": "string",
    "finished": "boolean"
  },
  "darumaId": "string",
  "url": "string"
}

Delete a Daruma

Delete a specific daruma.

DELETE/api/daruma/del/{darumaid}
Example
cURL
bash
curl -X DELETE 'https://verygoodgraphics.com/api/daruma/del/{darumaid}' \ 
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Request

Path Parameters

darumaidstringrequired
Responses
200
{
  "createdAt": "2023-09-28T10:47:39.689Z",
  "updatedAt": "2023-09-28T10:47:39.689Z",
  "id": "string",
  "name": "string",
  "userId": "string"
}

Convert a design file

Start convert task after upload is complete.

POST/api/daruma/import/convert
Example
cURL
bash
curl -X POST 'https://verygoodgraphics.com/api/daruma/import/convert?importId=string&quality=number' \ 
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"'' \ 
  -H "Content-Type: application/json"
Request

Query Parameters

importIdstringrequired
qualitynumber

The generated artboard image quality level. (1-4, default: 2)

Quality level 1 => max(width, height) == 1024;

Quality level 2 => max(width, height) == 2048;

Quality level 3 => max(width, height) == 4096;

Quality level 4 => max(width, height) == 8192.

Responses
200
{
  "taskId": "string"
}

Get all conversion statuses

Get all conversion task statuses for specific import.

GET/api/daruma/import/status
Example
cURL
bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/import/status?importId=string' \ 
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Request

Query Parameters

importIdstringrequired
Responses
200
{
  "taskId": {
    "parse": "boolean",
    "render": "boolean"
  }
}

Get a conversion status

Get the conversion task status for specific convert.

GET/api/daruma/import/status/task
Example
cURL
bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/import/status/task?taskId=string' \ 
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Request

Query Parameters

taskIdstringrequired
Responses
200
{
  "parse": "boolean",
  "render": "boolean"
}

Get the original file

Generate the download url of the original file of the last import.

GET/api/daruma/get/original
Example
cURL
bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/get/original?darumaId=string' \ 
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Request

Query Parameters

darumaIdstringrequired
Responses
200
{
  "url": "string"
}

Get last conversion status

Get task status of the last convert.

GET/api/daruma/get/status
Example
cURL
bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/get/status?darumaId=string' \ 
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Request

Query Parameters

darumaIdstringrequired
Responses
200
{
  "parse": "boolean",
  "render": "boolean"
}

Get the Daruma file

Get the complete daruma file containing all the data.

GET/api/daruma/get/file
Example
cURL
bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/get/file?darumaId=string' \ 
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Request

Query Parameters

darumaIdstringrequired
Responses
200
{
  "url": "string"
}

Get the daruma design data

Get the daruma design data as a JSON.

GET/api/daruma/get/design
Example
cURL
bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/get/design?darumaId=string' \ 
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Request

Query Parameters

darumaIdstringrequired
Responses
200
{
  "url": "string"
}

Get rendered images

Get rendered images for artboards in daruma design.

GET/api/daruma/get/resource/artboards
Example
cURL
bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/get/resource/artboards?darumaId=string' \ 
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Request

Query Parameters

darumaIdstringrequired
Responses
200
[
  "url"
]
Daruma Feedback