---
title: "Render images of file nodes"
method: GET
path: "/v1/images/{file_key}"
tags: ["Files"]
---

# Render images of file nodes

`GET /v1/images/{file_key}`

Renders images from a file.

If no error occurs, `"images"` will be populated with a map from node IDs to URLs of the rendered images, and `"status"` will be omitted. The image assets will expire after 30 days. Images up to 32 megapixels can be exported. Any images that are larger will be scaled down.

Important: the image map may contain values that are `null`. This indicates that rendering of that specific node has failed. This may be due to the node id not existing, or other reasons such has the node having no renderable components. It is guaranteed that any node that was requested for rendering will be represented in this map whether or not the render succeeded.

To render multiple images from the same file, use the `ids` query parameter to specify multiple node ids.

```
GET /v1/images/:key?ids=1:2,1:3,1:4
```

## Path parameters

- `file_key` string, required

## Query parameters

- `ids` string, required
- `version` string
- `scale` number
- `format` 'jpg' | 'png' | 'svg' | 'pdf'
- `svg_outline_text` boolean
- `svg_include_id` boolean
- `svg_include_node_id` boolean
- `svg_simplify_stroke` boolean
- `contents_only` boolean
- `use_absolute_bounds` boolean

## Response `200`

Response from the GET /v1/images/{file_key} endpoint.

- object
  - `err` unknown, required
  - `images` object, required — A map from node IDs to URLs of the rendered images.

## Other responses

- `400` — Bad request. Parameters are invalid or malformed. Please check the input formats. This error can also happen if the requested resources are too large to complete the request, which results in a timeout. Please reduce the number and size of objects requested.
- `403` — The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort.
- `404` — The requested file or resource was not found.
- `429` — In some cases API requests may be throttled or rate limited. Please wait a while before attempting the request again (typically a minute).
- `500` — An internal server error occurred.

---

[API](https://skmtc.net/thirdstrandstudio/apis/figma-api.md) · [All operations](https://skmtc.net/thirdstrandstudio/apis/figma-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/thirdstrandstudio/figma-api/versions/48f84f49653a/schema)