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": "2024-02-22T07:33:57.075Z",
    "updatedAt": "2024-02-22T07:33:57.075Z",
    "id": "string",
    "name": "string",
    "userId": "string",
    "darumaImports": [
      {
        "createdAt": "2024-02-22T07:33:57.075Z",
        "updatedAt": "2024-02-22T07:33:57.075Z",
        "id": "string",
        "uri": "string",
        "darumaId": "string",
        "finished": "boolean"
      }
    ],
    "taskStatus": {
      "parse": "boolean",
      "render": "boolean"
    },
    "thumbnail": "string"
  }
]

Get a Daruma

Get a specific daruma.

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

Query Parameters

darumaIdstringrequired
Responses
200
{
  "createdAt": "2024-02-22T07:33:57.076Z",
  "updatedAt": "2024-02-22T07:33:57.076Z",
  "id": "string",
  "name": "string",
  "userId": "string",
  "darumaImports": [
    {
      "createdAt": "2024-02-22T07:33:57.076Z",
      "updatedAt": "2024-02-22T07:33:57.076Z",
      "id": "string",
      "uri": "string",
      "darumaId": "string",
      "finished": "boolean"
    }
  ],
  "taskStatus": {
    "parse": "boolean",
    "render": "boolean"
  },
  "thumbnail": "string"
}

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
darumaIdstring
Responses
200
{
  "darumaImport": {
    "createdAt": "2024-02-22T07:33:57.077Z",
    "updatedAt": "2024-02-22T07:33:57.077Z",
    "id": "string",
    "uri": "string",
    "darumaId": "string",
    "finished": "boolean"
  },
  "darumaId": "string",
  "url": "string"
}

Delete a Daruma

Delete a specific daruma.

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

Query Parameters

darumaIdstringrequired
Responses
200
{
  "createdAt": "2024-02-22T07:33:57.078Z",
  "updatedAt": "2024-02-22T07:33:57.078Z",
  "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&size=number' \ -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"'' \ -H "Content-Type: application/json"
Request

Query Parameters

importIdstringrequired
sizenumber

The generated artboard image size. (default: 1x)

1x: Aspect ratio;

2x: Magnified by 1 time;

0.1x: Reduced by 10 times;

1024w: Width fixed at 1024;

1024h: Height fixed at 1024.

Note: Currently Daruma only supports a maximum export size of 8192. If the width or height exceeds this limit, it will be automatically resized to 8192.

Responses
200
{
  "taskId": "string"
}

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 last conversion status

Get the last conversion task status for specific daruma

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

Query Parameters

darumaIdstringrequired
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/original
Example
cURL
bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/original?darumaId=string' \ -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Request

Query Parameters

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

Get the Daruma file

Get the complete daruma file containing all the data.

GET/api/daruma/file
Example
cURL
bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/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/design
Example
cURL
bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/design?darumaId=string' \ -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Request

Query Parameters

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

Get the daruma layout data

Get the daruma layout data as a JSON.

GET/api/daruma/layout
Example
cURL
bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/layout?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/resource/artboards
Example
cURL
bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/resource/artboards?darumaId=string' \ -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Request

Query Parameters

darumaIdstringrequired
Responses
200
[
  "url"
]