API Reference
Get all Darumas
Get all the darumas of a specific user.
bashcurl -X GET 'https://verygoodgraphics.com/api/daruma/all' \ -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
[
{
"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.
bashcurl -X GET 'https://verygoodgraphics.com/api/daruma/get/daruma/{darumaid}' \ -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Path Parameters
{
"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.
bashcurl -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"}'
RequestBody
{
"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.
bashcurl -X DELETE 'https://verygoodgraphics.com/api/daruma/del/{darumaid}' \ -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Path Parameters
{
"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.
bashcurl -X POST 'https://verygoodgraphics.com/api/daruma/import/convert?importId=string&quality=number' \ -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"'' \ -H "Content-Type: application/json"
Query Parameters
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.
{
"taskId": "string"
}
Get all conversion statuses
Get all conversion task statuses for specific import.
bashcurl -X GET 'https://verygoodgraphics.com/api/daruma/import/status?importId=string' \ -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Query Parameters
{
"taskId": {
"parse": "boolean",
"render": "boolean"
}
}
Get a conversion status
Get the conversion task status for specific convert.
bashcurl -X GET 'https://verygoodgraphics.com/api/daruma/import/status/task?taskId=string' \ -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Query Parameters
{
"parse": "boolean",
"render": "boolean"
}
Get the original file
Generate the download url of the original file of the last import.
bashcurl -X GET 'https://verygoodgraphics.com/api/daruma/get/original?darumaId=string' \ -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Query Parameters
{
"url": "string"
}
Get last conversion status
Get task status of the last convert.
bashcurl -X GET 'https://verygoodgraphics.com/api/daruma/get/status?darumaId=string' \ -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Query Parameters
{
"parse": "boolean",
"render": "boolean"
}
Get the Daruma file
Get the complete daruma file containing all the data.
bashcurl -X GET 'https://verygoodgraphics.com/api/daruma/get/file?darumaId=string' \ -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Query Parameters
{
"url": "string"
}
Get the daruma design data
Get the daruma design data as a JSON.
bashcurl -X GET 'https://verygoodgraphics.com/api/daruma/get/design?darumaId=string' \ -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Query Parameters
{
"url": "string"
}
Get rendered images
Get rendered images for artboards in daruma design.
bashcurl -X GET 'https://verygoodgraphics.com/api/daruma/get/resource/artboards?darumaId=string' \ -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''
Query Parameters
[
"url"
]