create_attachment

imerit_ango.sdk.SDK.

create_attachment(project_id, attachments)

Add attachments to assets in a project—more on attachments and uploading them here.

Parameters

• project_id: string

  • The unique identifier for the project. You can find the project ID in the user interface or retrieve it using the list_projects function.

• attachments: List[dict]

  • List of attachments to attach to existing assets. Attachments are dictionaries containing information about the asset the attachment will be attached to, the type of attachment, and the content of the attachment.

Sample JSON

[
  {
    "externalId": "sample_image_1.png",
    "attachments": [
      {
        "type": "IMAGE",
        "value": "https://sample-attachment-image.jpg"
      },
      {
        "type": "TEXT",
        "value": "Some sample text."
      }
    ]
  },
  {
    "externalId": "sample_image_2.png",
    "attachments": [
      {
        "type": "VIDEO",
        "value": "https://sample-attachment-video.jpg"
      }
    ]
  }
]

Attachments can have one of the types "IMAGE", "TEXT", or "VIDEO".

For IMAGE and VIDEO, you will need to provide a link to the resource. JPG, PNG, and MP4 are supported.

For text, you will need to provide the text that will be attached.

For image and video attachments, you may provide links to assets in private buckets, provided that you've connected them to Ango Hub. More information on how to do so can be found on the Attachments page.

In AWS S3, if your attachment URL does not contain region information, your attachments may not be visible. When using S3, please ensure the region information is contained in the URL right after the bucket name, like so:

https://bucket-name.s3.eu-central-1.amazonaws.com/filename.JPG?storageId=111bb111389ff80015f2b914

Returns:

• output: dict

  • A dictionary containing the result of the operation.

  • Including a status field indicating whether the request was successful and a data field containing the response payload with updated resources produced by the operation.

Example

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

attachments = [
    {
        "externalId": "sample_image_1.png",
        "attachments": [
            {
                "type": "IMAGE",
                "value": "https://sample-attachment-image.jpg"
            },
            {
                "type": "TEXT",
                "value": "Some sample text."
            }
        ]
    },
    {
        "externalId": "sample_image_2.png",
        "attachments": [
            {
                "type": "VIDEO",
                "value": "https://sample-attachment-video.jpg"
            }
        ]
    }
]

ango_sdk.create_attachment(project_id=project_id, attachments=attachments)

curl

See also

Attachments