nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How can I add an image in a comment?

Julien Cambier

Hi and thank you for taking the time to read my question!

I want to add a comment to an issue through the API.

I can successfully add a comment to an issue and I can also successfully add an attachment to the issue. The problem is that I want to add an image IN a comment. On the Jira Website you can drop an image or add one through an explorer, so it is possible.

When I query an issue with an image as comment I see it as:

"content": [
     {
         "type": "mediaSingle",
         "attrs": {
             "layout": "center"
         },
         "content": [
             {
                 "type": "media",
                 "attrs": {
                     "id": "4f190z82-945d-4be6-cb21-9a815fb7f1v",
                     "type": "file",
                     "collection": "",
                     "width": 200,
                     "height": 183
                  }
              }
          ]
      }
 ]

I thought of adding a comment with this structure, but I'd need the ID to link the attachment. The ID of the comment attachment is super long ("4f190z82-945d-4be6-cb21-9a815fb7f1v") while the ID of the uploaded attachment is much shorter (23575).

Is there something I'm missing, or is adding an image as comment not possible through the API?

Accepted answers

All comments

Andy Heinzer

You can attach a file or image via the REST API in Jira. The thing to understand about doing this though is that it is not the exact same REST endpoint used to post a comment to an issue in Jira. I understand that since you can drag/drop an image in the comment box of Jira's web UI the appearance might be that you can do this in a single go. But when you do that, the image is actually being uploaded to the issue before you actually submit your comment. (You can test this by dragging an image file into a comment in Jira, and then not actually submitting your comment by then pressing 'Cancel', the image will still remain attached to the Jira issue).

So there are actually two different steps happening here, even in the web UI. In your case, I believe you're going to need to call two separate rest endpoints to make this work as well. Also you would need to make sure that the file attachment endpoint is being called first.

The KB on How to add an attachment to a JIRA issue using REST API explains how to upload images to Jira via the REST API.

Once the file is attached to the issue in question, then the steps need to reference that image in the comment is just using the wiki markup syntax to reference the filename of that image. So in Jira, if your attachment name was testimage.png, you can make your comment look something like this

test message here
!testimage.png|thumbnail!
see my image above

I hope this helps.

Andy

David_Bakkers

As Andy said, you have to attach the image to the issue first and know what its ID is before you can refer to it.

Mark Ahnell

This one took me a while to figure out with a lot of trial-and-error, so I feel I should share to save the world some time.

I am using Jira Cloud, so all the documentation pushes you to V3 API, which uses Atlassian Document Format. There is a section for embedding attachments under Node - media, however the documentation says you need to pass in an ID which you can get by "...querying the media services API to retrieve metadata, such as, filename. Consumers of the document should always fetch fresh metadata using the Media API." I have found no documentation on a "Media API", so I gave up on V3.

However, you can use the V2 Add Comment API in Jira Cloud.

First you call the Add Attachment API.

POST /rest/api/2/issue/{issueIdOrKey}/attachments

Response (trimmed for brevity)

{
  "self":"https://your-domain.atlassian.net/rest/api/2/attachments/12345",
  "id":"12345",
  "filename":"image-20210221-170959.png",
  "content":"https://your-company.atlassian.net/secure/attachments/12345/picture.jpg",
  "thumbnail":"https://your-company.atlassian.net/secure/thumbnail/12345/picture.jpg"
}

Using the "content" or "thumbnail" value, call the V2 Add Comment API and surround the value with ! on either end:

POST /rest/api/2/issue/{issueIdOrKey}/comment

{
  "body": "Here is my image !https://your-company.atlassian.net/secure/attachment/12345/image-20210221-170959.png!"
}

This also works if you are adding comments via the "External System Import":

JiraKey,Summary,Comment
TP-3,"Test API Issue","2021-02-21 03:00:00;5e5e5e5e5e5e5e5e5e5e5e5e;Here is my image !https://your-company.atlassian.net/secure/attachment/12345/image-20210221-170959.png!"

Laurent Houdard

Workaround using only V3 API:

add attachment
get attachment data
get "content" url without following redirections. The response will be a redirection, and the location contains the media ID.

PHP sample code:

$r1 = \Unirest\Request::get('/attachment/'.$attachment->id, [
  'Accept' => 'application/json'
]);

\Unirest\Request::curlOpt(CURLOPT_FOLLOWLOCATION, false);
$r2 = \Unirest\Request::get($r1->body->content);
\Unirest\Request::curlOpt(CURLOPT_FOLLOWLOCATION, true);

if ($r2->code === 302 && isset($r2->headers['location']) &&
    preg_match('|/file/([^/]+)/|', $r2->headers['location'], $matches)) {
  $mediaId = $matches[1];
}

Михаил Власенко

Insert it like external url

version: 1, type: 'doc', content: [ { "type": "mediaSingle", "content": [ { "type": "media", "attrs": { "type": "external", "url": "https://yordomain.atlassian.net/rest/api/2/attachment/content/10013", "width": 710, "height": 163, } } ] } ]

works perfect

Fabio Silva_hnpiwa

You are a real king. At least I don't need use any media api crazyness!

Andy Clapham_5rg65g

Thanks Laurent - that's rather painful

Oleksandr Panov

thank you, and even огромное спасибо

Shanee Dinay_5hozqc

This did not work for me.

I have the file attached to my Jira ticket already.

When I try the comment API with your example, it doesn't work.

I see this in my Jira ticket comment:

"!testing.txt|thumbnail! see my image"

Here is the API call:

curl --request POST \

--url "

https://${your_jira_domain}/rest/api/3/issue

/${JIRA_ISSUE}/comment" \

--user "${JIRA_USER}:${JIRA_TOKEN}" \

--header 'Accept: application/json' \

--header 'Content-Type: application/json' \

--data '{

"body": {

"content": [

{

"content": [

{

"text": "image !testing.txt|thumbnail! see my image above",

"type": "text"

}

"type": "paragraph"

}

"type": "doc",

"version": 1

}

Mark Ahnell

Make sure ${API_VERSION} = 2.

David Lee_ybce1u

Thank you!!

Mau Piñon

Hi everyone, after reading and try all your approaches for the V3 api version I can upload images from comments and here is the way that I follow to achieve it:

First of all we need to get the attachment id, thanks @Laurent Houdard to share your workaround this help me a lot! I did it with a python script like this:

import requests
import re
from requests.auth import HTTPBasicAuth

# Your Jira API URL
attachment_id = "33944"
url = f'https://yordomain.atlassian.net/rest/api/3/attachment/{attachment_id}'

# Basic authentication details
username = 'username' # Replace with your Jira username (email)
api_token = 'token' # Replace with your Jira API token

# Set up headers
headers = {
'Accept': 'application/json'
}

# Step 1: Get attachment data with Basic Auth
response1 = requests.get(url, headers=headers, auth=HTTPBasicAuth(username, api_token))
response1.raise_for_status() # Raise an error for a bad response

# Step 2: Get content URL from the response body and make the second request without following redirects
content_url = response1.json().get('content')

# If content URL exists
if content_url:
  response2 = requests.get(content_url, headers=headers, auth=HTTPBasicAuth(username, api_token), allow_redirects=False)

  # Step 3: Check for redirection (HTTP 302)
  if response2.status_code in [302, 303]: # check for both 302 and 303 as they are the same
    location = response2.headers.get('Location')
    if location:

      # Extract the media ID from the location URL
      match = re.search(r'/file/([^/]+)/', location)
      if match:
        media_id = match.group(1)
        print(f"Media ID: {media_id}")

else:
print("Content URL not found.")

Then I just post my comment by following the JDM documentation related to the mediaSingle.

I also used the JDM builder, because the documentation seems to don't have all the required fields needed.

So the final result to upload a comment with an image seems like this:

{

"body": {
"type": "doc",
"version": 1,
"content": [
   {
    "type": "paragraph",
    "content": [
      {

       "type": "text",
       "text": "try one more time"

      }]

   },
   {
   "type": "mediaSingle",
   "attrs": {
     "layout": "center"
   },

   "content": [
     {
     "type": "media",
     "attrs": {
        "type": "file",
         "id": "0ed70e26-c94f-4b90-8fb8-7bfd2db4b37a",
         "alt": "uploaded_from_comment_20241224070931.jpg",
         "collection": "",
         "width": 710,
         "height": 163

      }
     }
    ]
   }
  ]
 }
}

Just make sure to include al the fields that appears in the JDM builder, like the "collection" no matter that it is empty

Hope this work helps someone

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

jira

comment

developer

attachment