Open API Documentation

Request body: {} or omitted.

Response 200

{
  "firmware": "B100V050610",
  "nickname": "Inkanva",
  "lastHeartbeat": "2026-06-16T06:56:25.782Z",
  "isCharging": false,
  "batteryLevel": 100,
  "sdUsedSize": 0,
  "switchType": "queue",
  "switchMinute": 60,
  "imageId": 423,
  "coverId": null,
  "timezone": "America/Adak",
  "point": 30,
  "screenWidth": 800,
  "screenHeight": 480,
  "screenRotate": 270,
  "synced": false,
  "online": false
}

Field Notes

firmware

Current firmware version.

nickname

Device nickname.

lastHeartbeat

ISO8601 timestamp of the last heartbeat.

isCharging, batteryLevel

Current power state.

switchType, switchMinute

Image change strategy and interval.

screenWidth, screenHeight, screenRotate

Display geometry.

synced, online

Latest-image sync and connection status.

cURL

curl -X POST https://api.inkanva.com/openapi/device \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{}'

Request Body

{
  "base64": "/9j/4AAQSkZJRgABAQEAAAAAAAD...",
  "name": "photo.jpg"
}

Rules and Behavior

• base64 is required and must contain raw base64 image data without a data URL prefix.
• The frame image counter is incremented and the new image becomes active.
• name is optional and defaults to the original filename.
• Images are automatically cropped to the display area; match the screen ratio when possible.

Response 200

{ "id": 789, "counter": 10 }

cURL

curl -X POST https://api.inkanva.com/openapi/upload \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"base64":"<BASE64_DATA>","name":"photo.jpg"}'

Request body: {} or omitted.

Response 200

{
  "total": 2,
  "list": [
    {
      "id": 789,
      "name": "photo.jpg",
      "fileId": "abc123.jpg",
      "size": 182736,
      "type": "image/jpeg",
      "width": 800,
      "height": 480,
      "createdAt": "2026-05-14T08:00:00.000Z",
      "updatedAt": "2026-05-14T08:00:00.000Z",
      "current": true
    }
  ]
}

Field Notes

• total is the number of images belonging to the device.
• list contains images ordered by ID descending.
• current is true when the image is currently active.

cURL

curl -X POST https://api.inkanva.com/openapi/listImages \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{}'

Request Body

{ "imageId": 123 }

Rules and Behavior

• imageId is required and must belong to the device.
• The image file and database record are deleted together.
• The frame image counter is incremented after deletion.
• If the active image is deleted, the server switches to the next available image.
• If no images remain, the current image becomes null.

Response 200

{
  "success": true,
  "id": 123,
  "imageId": 122,
  "counter": 11
}

Errors

• 500 with { "message": "imageId is empty" } when the ID is missing or invalid.
• 500 with { "message": "image not found" } when the image does not belong to the device.

cURL

curl -X POST https://api.inkanva.com/openapi/deleteImage \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"imageId":123}'

Path Parameters

apikey

Device API key shown on the Frame settings page.

imageId

Image ID returned by the upload or list APIs.

The API key is passed in the URL path, so the Authorization header is not required.

Behavior

• Returns the original stored image file.
• The image must belong to the device identified by apikey.
• The response type is derived from the stored file extension, typically image/jpeg.

Response 200

Binary image stream.

Errors

• 404 with { "message": "image not found" } for an invalid or unrelated image ID.
• 500 with { "message": "can not find robot <apikey>" } for an unknown device key.

cURL

curl -L "https://api.inkanva.com/openapi/image/<API_KEY>/123" \
  -o image.jpg

Request Body

{ "imageId": 123 }

Response 200

{ "success": true }

Returns 500 with { "message": "image not found" } when the image does not belong to the device.

cURL

curl -X POST https://api.inkanva.com/openapi/displayImageById \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"imageId":123}'

Request Body

{ "imageName": "photo.jpg" }

Response 200

{ "success": true }

Returns 500 with { "message": "image not found" } when the image name is not found.

cURL

curl -X POST https://api.inkanva.com/openapi/displayImageByName \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"imageName":"photo.jpg"}'