VI | EN
Message us on Messenger
Developer resources

Get info about images — TikTok Business API

Get info about images · call it through Quantri360 with one API key for your own accounts / assets that you connected and authorized — 360 handles request signing and refreshing the authorization you granted.

Get info about images

GET/file/image/ad/info/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/file/image/ad/info/
Description

Use this endpoint to obtain the information of images from the Asset Library.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/file/image/ad/info/

Authentication & shop

NameInTypeSampleDescription
AuthorizationheaderheaderBearer q360_live_ab12cd34_…Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand.
platform_shop_idquerystring7000000000000000001Tài sản TikTok Business đã kết nối — "Mã tài sản" ở trang Nền tảng hoặc GET /v1/platforms (tài khoản quảng cáo cho Marketing API, tài khoản TikTok cho Organic / Messaging). Có thể bỏ khi chỉ kết nối một tài sản.

Request parameters

NameInTypeRequiredSampleDescription
image_idsquerystring[]YesImage ID list. Up to 100 IDs per request. Note: If you obtain the image IDs of thumbnails for ads created on TikTok Ads Manager using the /ad/get/ endpoint, they are not supported. This is because these thumbnails have not been uploaded to the Asset Library and linked to your ad account.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/file/image/ad/info/?image_ids=%5B%5D" \
  -H "Authorization: Bearer $KEY"
Python
import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.get(
    "https://partner.quantri360.com/v1/tiktok_business/file/image/ad/info/",
    params={
        "image_ids": []
    },
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())
Node.js
const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/file/image/ad/info/');
for (const [k, v] of Object.entries({"image_ids":[]})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
  method: 'GET',
  headers: { Authorization: `Bearer ${KEY}` },
});
console.log(r.status, await r.json());
PHP
<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/file/image/ad/info/' . '?' . http_build_query(['image_ids' => '[]']);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key]);
$res = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, "\n", $res;

Response

Response fields (as returned by TikTok Business)

NameTypeSampleDescription
codenumberReturn code. For the complete list of response codes and descriptions, see Appendix-Return code.
messagestringReturn message. For details, see Appendix-Return Information.
dataobjectReturned Data.
listobject[]Information about the images.
image_idstringImage ID, used to create ads.
material_idstringMaterial ID.
is_carousel_usablebooleanWhether the source of the image is valid for Carousel Ads. Note: To use an image in Carousel Ads, you need to ensure: - The value of this field is `true`, and - The image meets the specifications requirements listed in Create Carousel Ads-Steps-Create an ad.
widthnumberImage width.
formatstringImage format.
image_urlstringImage URL, valid for an hour and needs to be re-acquired after expiration.
heightnumberImage height.
signaturestringMD5 of picture.
sizenumberImage size in bytes.
file_namestringImage name.
create_timestringCreation time. UTC time. Format: 2020-06-10T07:39:14Z.
modify_timestringModification time. UTC time. Format: 2020-06-10T07:39:14Z.
displayablebooleanWhether it can be displayed on the platform.
request_idstringThe log id of a request, which uniquely identifies the request.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "list": [
            {
                "is_carousel_usable": true,
                "size": 39779,
                "format": "jpeg",
                "modify_time": "{{modify_time}}",
                "create_time": "{{create_time}}",
                "displayable": false,
                "width": 750,
                "material_id": "{{material_id}}",
                "image_url": "{{image_url}}",
                "file_name": "{{file_name}}",
                "image_id": "{{image_id}}",
                "signature": "{{signature}}",
                "height": 422
            }
        ]
    }
}
(/code);

Get started

  1. Sign up for Partner
  2. Enable a data type of the Ads (Marketing API) group on the platform page
  3. Create an API key (tick the TikTok Business channel)
  4. Call it as in the examples above