---
title: REST API - Get Artifact Image Request
slug: rm/rest-api-get-artifact-image-request
docTags: 
createdAt: 2026-06-09T13:38:46.416Z
---

```bash
api/v1/projects/{projectId}/artifacts/{artifactId}/image
```

# Description

Retrieves the main image from the specified graphical artifact in PNG format. Graphical artifacts include use case diagrams, generic diagrams, business process diagrams, domain diagrams, and UI mockups.

This is the main image from an example business process diagram:

# URL Structure

```bash
[Blueprint_URI]/api/v1/projects/{projectId}/artifacts/{artifactId}/image
```

- `ProjectId`: The ID of the project that contains the artifact image you want to get.
- `ArtifactId`: The ID of the artifact containing the image you want to get.

# Supported Methods

- [HEAD](docId\:EQND3ZpTD6DwF3go3ufox)
- [GET](docId:7HM2r-Py7e84XK2mSf11b)

# HTTP Status Codes

- 200: OK
- 201: Successfully Created
- 206: Partial Content
- 400: Bad Request
  This error can occur for a variety of reasons:
  - At least one URI or request body parameter is invalid, such as one of the [Filter](docId\:Sv9GjVErxCZcgqdn28J7U), Traces, Offset or Limit parameters.
  - A required value has not been provided.
  - If you are submitting a [POST](docId\:Hsi_LzXS8g_RX_ydUdZKg) or [PATCH](docId\:RcjvHRLbY6de-zGKeHxuI) request and have not added the `X-HTTP-Method-Override` parameter to your request header.
- 401: Unauthorized
  - The Blueprint token is missing, invalid or expired.
- 403: Forbidden
  - The applicable permissions are needed. For example, this error can occur when:
    - An Author or Collaborate license is needed for access.
    - Comment permissions are needed on the artifact.
    - Edit permissions are needed on the change summary job.
- 404: NotFound
  - Item is not found in the project. For example, this error can occur when:
    - Artifact not found.
    - Artifact type not found.
    - Project not found.
    - ALM target not found.
    - Change summary job not found.
    - User does not have edit permissions for this artifact, project or ALM target.
- 409: Conflict
  - Reason for failure can be found in the response body. Additional information may also be found in the log.
- 411: Length Required
  - If the Content-Length header is missing in the request.
- 413: Request Entity Too Large
  - If the provided file size is larger than allowed.
- 415: Unsupported Media Type
  - If the provided media type is not of MIME Multipart Content "form-data."
- 416: Request Range Not Satisfiable
  - If `offset `points to a part of a collection that is not available.
- 500: Internal Server Error
- 501: Not Implemented

# Examples

## XML Example

**Request URI**

```bash
https://production.blueprintcloud.com/api/v1/projects/220870/artifacts/220914/image
```

**Response Body**

The image data is contained in the response body.

The response header contains important information about the image, such as:

- `content-length`: The size of the response.
- `content-disposition`:  The content type and the name of the file. For example: `image; filename="New Use Case 1.png"`.
- `content-type`: The response content type, which is `image/png` in this case.

## JSON Example

**Request URI**

```bash
https://production.blueprintcloud.com/api/v1/projects/220870/artifacts/220914/image
```

**Response Body**

The image data is contained in the response body.

The response header contains important information about the image, such as:

- `content-length`: The size of the response.
- `content-disposition`:  The content type and the name of the file. For example: `image; filename="New Use Case 1.png"`.
- `content-type`: The response content type, which is `image/png` in this case.