| detect_ai_generated_image | Accepts an image file as input and analyzes it to determine the probability that the image was generated by artificial intelligence, providing a confidence score. Responses: - 200 (Success): OK - The request has succeeded, and the image has been classified.
- Content-Type:
application/json - Response Properties:
- Example:
{
"data": [
{
"probability": 0.9489172697067261,
"class_name": "not_ai"
},
{
"probability": 0.9489172697067261,
"class_name": "not_ai"
}
]
} - 400: Bad Request - The server could not understand the request due to invalid syntax.
- Content-Type:
application/json - Response Properties:
- Example:
- 401: Unauthorized - The client must authenticate itself to get the requested response.
- Content-Type:
application/json - Response Properties:
- Example:
- 500: Internal Server Error - The server has encountered a situation it doesn't know how to handle.
- Content-Type:
application/json - Response Properties:
- Example:
{
"message": "Internal Server Error"
} - 503: Service Unavailable
- Content-Type:
application/json - Response Properties:
- Example:
{
"message": "Service Unavailable. Please try again later."
} |
| search_resources | Retrieve a list of resources based on various filter criteria such as orientation, content type, license, and more. Query Parameters: - page: Page number. It must be greater than 0 and less than or equal to 100.
- limit: Limit results per page. It must be greater than 0.
- order: Specifies the order in which search results are returned. The available options allow you to prioritize results based on different criteria:
relevance: Prioritizes results that are most relevant to the search query.recent: Sorts results by the most recent updates.- term: Search term. If only term comes, it is searched for term, if only slug comes, it is searched for slug and if both come, it is searched for slug
- filters[orientation][landscape]: Filters results to only include resources with a landscape orientation. Set to 1 to enable, 0 to disable.
- filters[orientation][portrait]: Filters results to only include resources with a portrait orientation. Set to 1 to enable, 0 to disable.
- filters[orientation][square]: Filters results to only include resources with a square orientation. Set to 1 to enable, 0 to disable.
- filters[orientation][panoramic]: Filters results to only include resources with a panoramic orientation. Set to 1 to enable, 0 to disable.
- filters[content_type][photo]: Filters results to only include resources of type photo. Set to 1 to enable, 0 to disable.
- filters[content_type][psd]: Filters results to only include resources of type PSD (Photoshop Document). Set to 1 to enable, 0 to disable.
- filters[content_type][vector]: Filters results to only include resources of type vector. Set to 1 to enable, 0 to disable.
- filters[license][freemium]: Filters results to only include resources with a freemium license. Set to 1 to enable, 0 to disable.
- filters[license][premium]: Filters results to only include resources with a premium license. Set to 1 to enable, 0 to disable.
- filters[people][include]: Filter by included people
- filters[people][exclude]: Filter by excluded people
- filters[people][number]: Filter by number of people
- filters[people][age]: Filter by age of the people
- filters[people][gender]: Filter by gender of the people
- filters[people][ethnicity]: Filter by ethnicity of the people
- filters[period]: Filters results based on the time period in which the resources were added.
- filters[color]: Filters results by the predominant color in the resources.
- filters[author]: Filters results to include resources by a specific author, identified by their author ID.
- filters[ai-generated][excluded]: Excludes AI-generated images from the results. Set to 1 to exclude, 0 to include.
- filters[ai-generated][only]: Filters results to only include AI-generated images. Set to 1 to include only AI-generated images, 0 to include all images.
- filters[vector][type]: File type for vectors
- filters[vector][style]: Style type for vectors, ignored if content_type exists and it is not vector
- filters[psd][type]: File type for psd
- filters[ids]: Filter by list of ids. This filter is incompatible with any other filters. In case of using this filter, the rest of filters will be ignored.
Responses: - 200 (Success): Ok Response
- Content-Type:
application/json - Response Properties:
- data: A list of resources.
- Example:
{
"data": [
{
"image": {
"orientation": "horizontal",
"source": {
"size": "740x640",
"key": "large",
"url": "https://img.freepik.com/free-photo/tshirt_53876-104920.jpg"
},
"type": "vector"
},
"licenses": [
{
"type": "freemium",
"url": "https://www.freepik.com/profile/license/pdf/4350594"
},
{
"type": "freemium",
"url": "https://www.freepik.com/profile/license/pdf/4350594"
}
],
"filename": "filename",
"related": {
"keywords": {
"name": "Merry Christmas",
"slug": "merry-christmas"
},
"serie": {
"image": {
"orientation": "horizontal",
"source": {
"size": "740x640",
"key": "large",
"url": "https://img.freepik.com/free-photo/tshirt_53876-104920.jpg"
},
"type": "vector"
},
"licenses": [
{
"type": "freemium",
"url": "https://www.freepik.com/profile/license/pdf/4350594"
},
{
"type": "freemium",
"url": "https://www.freepik.com/profile/license/pdf/4350594"
}
],
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"id": 15667327,
"title": "White t-shirt with copy space on gray background",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
},
"others": {
"image": {
"orientation": "horizontal",
"source": {
"size": "740x640",
"key": "large",
"url": "https://img.freepik.com/free-photo/tshirt_53876-104920.jpg"
},
"type": "vector"
},
"licenses": [
{
"type": "freemium",
"url": "https://www.freepik.com/profile/license/pdf/4350594"
},
{
"type": "freemium",
"url": "https://www.freepik.com/profile/license/pdf/4350594"
}
],
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"id": 15667327,
"title": "White t-shirt with copy space on gray background",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
}
},
"stats": {
"downloads": 0,
"likes": 0
},
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"meta": {
"is_new": true,
"available_formats": {
"psd": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"jpg": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"zip": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"fonts": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"svg": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"ai": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"png": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"eps": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"resources": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"3d-render": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"atn": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
}
},
"published_at": "2020-12-01T23:50:50Z"
},
"id": 15667327,
"title": "White t-shirt with copy space on gray background",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm",
"products": [
{
"type": "essential",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
},
{
"type": "essential",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
}
]
},
{
"image": {
"orientation": "horizontal",
"source": {
"size": "740x640",
"key": "large",
"url": "https://img.freepik.com/free-photo/tshirt_53876-104920.jpg"
},
"type": "vector"
},
"licenses": [
{
"type": "freemium",
"url": "https://www.freepik.com/profile/license/pdf/4350594"
},
{
"type": "freemium",
"url": "https://www.freepik.com/profile/license/pdf/4350594"
}
],
"filename": "filename",
"related": {
"keywords": {
"name": "Merry Christmas",
"slug": "merry-christmas"
},
"serie": {
"image": {
"orientation": "horizontal",
"source": {
"size": "740x640",
"key": "large",
"url": "https://img.freepik.com/free-photo/tshirt_53876-104920.jpg"
},
"type": "vector"
},
"licenses": [
{
"type": "freemium",
"url": "https://www.freepik.com/profile/license/pdf/4350594"
},
{
"type": "freemium",
"url": "https://www.freepik.com/profile/license/pdf/4350594"
}
],
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"id": 15667327,
"title": "White t-shirt with copy space on gray background",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
},
"others": {
"image": {
"orientation": "horizontal",
"source": {
"size": "740x640",
"key": "large",
"url": "https://img.freepik.com/free-photo/tshirt_53876-104920.jpg"
},
"type": "vector"
},
"licenses": [
{
"type": "freemium",
"url": "https://www.freepik.com/profile/license/pdf/4350594"
},
{
"type": "freemium",
"url": "https://www.freepik.com/profile/license/pdf/4350594"
}
],
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"id": 15667327,
"title": "White t-shirt with copy space on gray background",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
}
},
"stats": {
"downloads": 0,
"likes": 0
},
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"meta": {
"is_new": true,
"available_formats": {
"psd": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"jpg": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"zip": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"fonts": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"svg": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"ai": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"png": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"eps": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"resources": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"3d-render": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"atn": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
}
},
"published_at": "2020-12-01T23:50:50Z"
},
"id": 15667327,
"title": "White t-shirt with copy space on gray background",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm",
"products": [
{
"type": "essential",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
},
{
"type": "essential",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
}
]
}
],
"meta": {
"per_page": 1,
"total": 1,
"last_page": 1,
"current_page": 1,
"clean_search": true
}
} - 400: Bad Request - The server could not understand the request due to invalid syntax.
- Content-Type:
application/json - Response Properties:
- Example:
- 401: Unauthorized - The client must authenticate itself to get the requested response.
- Content-Type:
application/json - Response Properties:
- Example:
- 403: Forbidden - The client does not have permission to access the requested resource.
- Content-Type:
application/json - Response Properties:
- Example:
- 404: Not Found - The server can not find the requested resource.
- Content-Type:
application/json - Response Properties:
- Example:
- 503: Service Unavailable
- Content-Type:
application/json - Response Properties:
- Example:
{
"message": "Service Unavailable. Please try again later."
} |
| get_resource_detail_by_id | Retrieve the detailed information of a specific resource by its ID. This endpoint supports multiple resource types including PSD, vector, photo, and AI-generated content. Path Parameters: - resource-id (Required): Photo, video or PSD resource ID
Responses: - 200 (Success): OK Response
- Content-Type:
application/json - Response Properties:
- Example:
{
"data": {
"preview": {
"width": 300,
"url": "https://www.freepik.com/free-ai-image/surreal-landscape_41357833.htm",
"height": 500
},
"new": true,
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"created": "2023-03-07T23:05:26Z",
"available_formats": {
"psd": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"jpg": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"zip": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"fonts": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"svg": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"ai": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"png": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"eps": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"resources": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"3d-render": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
},
"atn": {
"total": 1,
"items": [
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
},
{
"size": 100,
"colorspace": "RGB",
"name": "image.jpg",
"id": 1
}
]
}
},
"type": "photo",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm",
"license": "https://www.freepik.com/profile/license/pdf/4350594",
"premium": true,
"is_ai_generated": true,
"related_resources": {
"suggested": [
{
"preview": {
"width": 300,
"url": "https://www.freepik.com/free-ai-image/surreal-landscape_41357833.htm",
"height": 500
},
"new": true,
"premium": true,
"is_ai_generated": true,
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "White t-shirt with copy space on gray background",
"id": 15667327,
"type": "vector",
"has_prompt": true,
"slug": "merry-christmas",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
},
{
"preview": {
"width": 300,
"url": "https://www.freepik.com/free-ai-image/surreal-landscape_41357833.htm",
"height": 500
},
"new": true,
"premium": true,
"is_ai_generated": true,
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "White t-shirt with copy space on gray background",
"id": 15667327,
"type": "vector",
"has_prompt": true,
"slug": "merry-christmas",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
}
],
"same_author": [
{
"preview": {
"width": 300,
"url": "https://www.freepik.com/free-ai-image/surreal-landscape_41357833.htm",
"height": 500
},
"new": true,
"premium": true,
"is_ai_generated": true,
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "White t-shirt with copy space on gray background",
"id": 15667327,
"type": "vector",
"has_prompt": true,
"slug": "merry-christmas",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
},
{
"preview": {
"width": 300,
"url": "https://www.freepik.com/free-ai-image/surreal-landscape_41357833.htm",
"height": 500
},
"new": true,
"premium": true,
"is_ai_generated": true,
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "White t-shirt with copy space on gray background",
"id": 15667327,
"type": "vector",
"has_prompt": true,
"slug": "merry-christmas",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
}
],
"same_collection": {
"items": [
{
"preview": {
"width": 300,
"url": "https://www.freepik.com/free-ai-image/surreal-landscape_41357833.htm",
"height": 500
},
"new": true,
"premium": true,
"is_ai_generated": true,
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "White t-shirt with copy space on gray background",
"id": 15667327,
"type": "vector",
"has_prompt": true,
"slug": "merry-christmas",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
},
{
"preview": {
"width": 300,
"url": "https://www.freepik.com/free-ai-image/surreal-landscape_41357833.htm",
"height": 500
},
"new": true,
"premium": true,
"is_ai_generated": true,
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "White t-shirt with copy space on gray background",
"id": 15667327,
"type": "vector",
"has_prompt": true,
"slug": "merry-christmas",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
}
],
"url": "https://www.freepik.com/collection/shining"
},
"same_series": {
"items": [
{
"preview": {
"width": 300,
"url": "https://www.freepik.com/free-ai-image/surreal-landscape_41357833.htm",
"height": 500
},
"new": true,
"premium": true,
"is_ai_generated": true,
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "White t-shirt with copy space on gray background",
"id": 15667327,
"type": "vector",
"has_prompt": true,
"slug": "merry-christmas",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
},
{
"preview": {
"width": 300,
"url": "https://www.freepik.com/free-ai-image/surreal-landscape_41357833.htm",
"height": 500
},
"new": true,
"premium": true,
"is_ai_generated": true,
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "White t-shirt with copy space on gray background",
"id": 15667327,
"type": "vector",
"has_prompt": true,
"slug": "merry-christmas",
"url": "https://www.freepik.com/free-photo/white-t-shirts-with-copy-space-gray-background_15667327.htm"
}
],
"url": "https://www.freepik.com/serie/32689488"
}
},
"name": "White t-shirt with copy space on gray background",
"id": 15667327,
"has_prompt": true,
"download_size": 1024,
"slug": "merry-christmas",
"related_tags": [
{
"name": "Merry Christmas",
"slug": "merry-christmas",
"url": "https://www.freepik.com/dog"
},
{
"name": "Merry Christmas",
"slug": "merry-christmas",
"url": "https://www.freepik.com/dog"
}
],
"dimensions": {
"width": 2000,
"height": 3000
}
}
} - 400: Bad Request - The server could not understand the request due to invalid syntax.
- Content-Type:
application/json - Response Properties:
- Example:
- 401: Unauthorized - The client must authenticate itself to get the requested response.
- Content-Type:
application/json - Response Properties:
- Example:
- 404: Not Found - The server can not find the requested resource.
- Content-Type:
application/json - Response Properties:
- Example:
- 500: Internal Server Error - The server has encountered a situation it doesn't know how to handle.
- Content-Type:
application/json - Response Properties:
- Example:
{
"message": "Internal Server Error"
} - 503: Service Unavailable
- Content-Type:
application/json - Response Properties:
- Example:
{
"message": "Service Unavailable. Please try again later."
} |
| download_resource_by_id | Download a specific resource by providing the resource ID. This endpoint supports downloading various types of resources including vectors, PSDs, photos, and AI-generated content. Path Parameters: - resource-id (Required): Photo, video or PSD resource ID
Query Parameters: - image_size: Resizes the photo to a specified size while maintaining aspect ratio. Accepts a pixel value (100px to 2000px) or
keywords small(1000px), medium(1500px), large(2000px), original corresponding to standard website sizes.
The size depends on the image orientation, the longest side of the image will be resized to the specified size.
If not specified, the highest resolution is provided. Applicable only to photos.
Responses: - 200 (Success): OK Response
- Content-Type:
application/json - Response Properties:
- Example:
{
"data": {
"signed_url": "https://img.freepik.com/premium-photo/close-up-cat-resting_1048944-9269194.jpg?t=st=1725276607~exp=1725280207~hmac=1538f1b294fc3a19a19e9f02ceeb6594a9a1e36a900de85d47bbd386e27dddbe",
"filename": "blackboard-template.zip",
"url": "https://downloadscdn5.freepik.com/d/1137445/blackboard-template.zip"
}
} - 400: Bad Request - The server could not understand the request due to invalid syntax.
- Content-Type:
application/json - Response Properties:
- Example:
- 401: Unauthorized - The client must authenticate itself to get the requested response.
- Content-Type:
application/json - Response Properties:
- Example:
- 403: Forbidden - The client does not have permission to access the requested resource.
- Content-Type:
application/json - Response Properties:
- Example:
- 404: Not Found - The server can not find the requested resource.
- Content-Type:
application/json - Response Properties:
- Example:
- 429: Too Many Requests - The client has sent too many requests in a given amount of time.
- Content-Type:
application/json - Response Properties:
- Example:
- 500: Internal Server Error - The server has encountered a situation it doesn't know how to handle.
- Content-Type:
application/json - Response Properties:
- Example:
{
"message": "Internal Server Error"
} - 503: Service Unavailable
- Content-Type:
application/json - Response Properties:
- Example:
{
"message": "Service Unavailable. Please try again later."
} |
| get_resource_download_formats | Retrieve a resource by specifying both the resource ID and the format. This endpoint allows for precise downloading of resources in the desired format. Path Parameters: - resource-id (Required): Photo, video or PSD resource ID
- resource-format (Required): Resource format
Responses: - 200 (Success): OK
- Content-Type:
application/json - Response Properties:
- Example:
{
"data": [
{
"signed_url": "https://img.freepik.com/premium-photo/close-up-cat-resting_1048944-9269194.jpg?t=st=1725276607~exp=1725280207~hmac=1538f1b294fc3a19a19e9f02ceeb6594a9a1e36a900de85d47bbd386e27dddbe",
"filename": "blackboard-template.zip",
"url": "https://downloadscdn5.freepik.com/d/1137445/blackboard-template.zip"
},
{
"signed_url": "https://img.freepik.com/premium-photo/close-up-cat-resting_1048944-9269194.jpg?t=st=1725276607~exp=1725280207~hmac=1538f1b294fc3a19a19e9f02ceeb6594a9a1e36a900de85d47bbd386e27dddbe",
"filename": "blackboard-template.zip",
"url": "https://downloadscdn5.freepik.com/d/1137445/blackboard-template.zip"
}
]
} - 400: Bad Request - The server could not understand the request due to invalid syntax.
- Content-Type:
application/json - Response Properties:
- Example:
- 401: Unauthorized - The client must authenticate itself to get the requested response.
- Content-Type:
application/json - Response Properties:
- Example:
- 403: Forbidden - The client does not have permission to access the requested resource.
- Content-Type:
application/json - Response Properties:
- Example:
- 404: Not Found - The server can not find the requested resource.
- Content-Type:
application/json - Response Properties:
- Example:
- 429: Too Many Requests - The client has sent too many requests in a given amount of time.
- Content-Type:
application/json - Response Properties:
- Example:
- 500: Internal Server Error - The server has encountered a situation it doesn't know how to handle.
- Content-Type:
application/json - Response Properties:
- Example:
{
"message": "Internal Server Error"
} |
| search_icons | Get a list of icons based on the provided parameters and ordering criteria. Query Parameters: - term: Search term. If only term comes, it is searched for term, if only slug comes, it is searched for slug and if both come, it is searched for slug
- slug: Search by slug
- page: Page number. It must be greater than 0.
- per_page: Results per page. It must be greater than 0.
- family-id: Icon family id.
- order: Define order of results.
- Note: If the term or slug parameter is used, the order will be the similarity of the search.
- filters[color]: Filter by color.
- filters[shape]: Filter by shape.
- filters[period]: Filter by period.
- filters[free_svg]: Filter by free svg, for free or premium item or all for both
- filters[icon_type][]: Filter of available icon types.
- thumbnail_size: Size of the thumbnail.
If the size is not specified, the API will return 128 as a default size.
Responses: - 200 (Success): OK Response
- Content-Type:
application/json - Response Properties:
- Example:
{
"data": [
{
"free_svg": true,
"created": "2023-03-07T23:05:26Z",
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "a woman reads a book in a tablet sits in the luxurious back of the library",
"style": {
"name": "Meticulous Yellow shadow",
"id": 50
},
"id": 52912,
"family": {
"total": 1200,
"name": "Outline",
"id": 1
},
"thumbnails": [
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
},
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
}
],
"slug": "a-woman-reads-a-book-in-a-tablet-sits-in-the-luxurious-back-of-the-library",
"tags": [
{
"name": "Dog",
"slug": "dog"
},
{
"name": "Dog",
"slug": "dog"
}
]
},
{
"free_svg": true,
"created": "2023-03-07T23:05:26Z",
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "a woman reads a book in a tablet sits in the luxurious back of the library",
"style": {
"name": "Meticulous Yellow shadow",
"id": 50
},
"id": 52912,
"family": {
"total": 1200,
"name": "Outline",
"id": 1
},
"thumbnails": [
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
},
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
}
],
"slug": "a-woman-reads-a-book-in-a-tablet-sits-in-the-luxurious-back-of-the-library",
"tags": [
{
"name": "Dog",
"slug": "dog"
},
{
"name": "Dog",
"slug": "dog"
}
]
}
],
"meta": {
"pagination": {
"per_page": 1,
"total": 1,
"last_page": 1,
"current_page": 1
}
}
} - 400: Bad Request - The server could not understand the request due to invalid syntax.
- Content-Type:
application/json - Response Properties:
- Example:
- 401: Unauthorized - The client must authenticate itself to get the requested response.
- Content-Type:
application/json - Response Properties:
- Example:
- 404: Not Found - The server can not find the requested resource.
- Content-Type:
application/json - Response Properties:
- Example:
- 500: Internal Server Error - The server has encountered a situation it doesn't know how to handle.
- Content-Type:
application/json - Response Properties:
- Example:
{
"message": "Internal Server Error"
} |
| get_icon_detail_by_id | Get detailed information about a specific icon identified by its unique ID. Path Parameters: - id (Required): Icon resource ID
Responses: - 200 (Success): OK
- Content-Type:
application/json - Response Properties:
- Example:
{
"data": {
"free_svg": true,
"related": {
"visual_concept": [
{
"free_svg": true,
"created": "2023-03-07T23:05:26Z",
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "a woman reads a book in a tablet sits in the luxurious back of the library",
"style": {
"name": "Meticulous Yellow shadow",
"id": 50
},
"id": 52912,
"family": {
"total": 1200,
"name": "Outline",
"id": 1
},
"thumbnails": [
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
},
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
}
],
"slug": "a-woman-reads-a-book-in-a-tablet-sits-in-the-luxurious-back-of-the-library"
},
{
"free_svg": true,
"created": "2023-03-07T23:05:26Z",
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "a woman reads a book in a tablet sits in the luxurious back of the library",
"style": {
"name": "Meticulous Yellow shadow",
"id": 50
},
"id": 52912,
"family": {
"total": 1200,
"name": "Outline",
"id": 1
},
"thumbnails": [
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
},
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
}
],
"slug": "a-woman-reads-a-book-in-a-tablet-sits-in-the-luxurious-back-of-the-library"
}
],
"style": [
{
"free_svg": true,
"created": "2023-03-07T23:05:26Z",
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "a woman reads a book in a tablet sits in the luxurious back of the library",
"style": {
"name": "Meticulous Yellow shadow",
"id": 50
},
"id": 52912,
"family": {
"total": 1200,
"name": "Outline",
"id": 1
},
"thumbnails": [
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
},
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
}
],
"slug": "a-woman-reads-a-book-in-a-tablet-sits-in-the-luxurious-back-of-the-library"
},
{
"free_svg": true,
"created": "2023-03-07T23:05:26Z",
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "a woman reads a book in a tablet sits in the luxurious back of the library",
"style": {
"name": "Meticulous Yellow shadow",
"id": 50
},
"id": 52912,
"family": {
"total": 1200,
"name": "Outline",
"id": 1
},
"thumbnails": [
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
},
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
}
],
"slug": "a-woman-reads-a-book-in-a-tablet-sits-in-the-luxurious-back-of-the-library"
}
],
"variants": [
{
"free_svg": true,
"created": "2023-03-07T23:05:26Z",
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "a woman reads a book in a tablet sits in the luxurious back of the library",
"style": {
"name": "Meticulous Yellow shadow",
"id": 50
},
"id": 52912,
"family": {
"total": 1200,
"name": "Outline",
"id": 1
},
"thumbnails": [
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
},
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
}
],
"slug": "a-woman-reads-a-book-in-a-tablet-sits-in-the-luxurious-back-of-the-library"
},
{
"free_svg": true,
"created": "2023-03-07T23:05:26Z",
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "a woman reads a book in a tablet sits in the luxurious back of the library",
"style": {
"name": "Meticulous Yellow shadow",
"id": 50
},
"id": 52912,
"family": {
"total": 1200,
"name": "Outline",
"id": 1
},
"thumbnails": [
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
},
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
}
],
"slug": "a-woman-reads-a-book-in-a-tablet-sits-in-the-luxurious-back-of-the-library"
}
]
},
"created": "2023-03-07T23:05:26Z",
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "a woman reads a book in a tablet sits in the luxurious back of the library",
"style": {
"name": "Meticulous Yellow shadow",
"id": 50
},
"id": 52912,
"family": {
"total": 1200,
"name": "Outline",
"id": 1
},
"thumbnails": [
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
},
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
}
],
"slug": "a-woman-reads-a-book-in-a-tablet-sits-in-the-luxurious-back-of-the-library",
"tags": [
{
"name": "Dog",
"slug": "dog"
},
{
"name": "Dog",
"slug": "dog"
}
]
}
} - 400: Bad Request - The server could not understand the request due to invalid syntax.
- Content-Type:
application/json - Response Properties:
- Example:
- 401: Unauthorized - The client must authenticate itself to get the requested response.
- Content-Type:
application/json - Response Properties:
- Example:
- 404: Not Found - The server can not find the requested resource.
- Content-Type:
application/json - Response Properties:
- Example:
- 500: Internal Server Error - The server has encountered a situation it doesn't know how to handle.
- Content-Type:
application/json - Response Properties:
- Example:
{
"message": "Internal Server Error"
} |
| download_icon_by_id | Download the specified icon by its unique ID in the requested format and size. Path Parameters: - id (Required): Icon resource ID
Query Parameters: - format: These are the formats available for download
- Note: gif, mp4, aep, json, psd and eps are not available for standard and sticker icon types.
- png_size: These are the sizes available for png_url formats.
- Note: Only apply to format png.
Responses: - 200 (Success): OK
- Content-Type:
application/json - Response Properties:
- Example:
{
"data": {
"filename": "filename",
"url": "https://openapi-generator.tech"
}
} - 400: Bad Request - The server could not understand the request due to invalid syntax.
- Content-Type:
application/json - Response Properties:
- Example:
- 401: Unauthorized - The client must authenticate itself to get the requested response.
- Content-Type:
application/json - Response Properties:
- Example:
- 403: Forbidden - The client does not have permission to access the requested resource.
- Content-Type:
application/json - Response Properties:
- Example:
- 404: Not Found - The server can not find the requested resource.
- Content-Type:
application/json - Response Properties:
- Example:
- 429: Too Many Requests - The client has sent too many requests in a given amount of time.
- Content-Type:
application/json - Response Properties:
- Example:
- 500: Internal Server Error - The server has encountered a situation it doesn't know how to handle.
- Content-Type:
application/json - Response Properties:
- Example:
{
"message": "Internal Server Error"
} |
| text_to_image_mystic_sync | Convert descriptive text input into images using AI. This endpoint accepts a variety of parameters to customize the generated images. Responses: - 200 (Success): OK - The request has succeeded and the Mystic process has started.
- Content-Type:
application/json - Response Properties:
- Example:
{
"data": {
"generated": [
"https://openapi-generator.tech",
"https://openapi-generator.tech"
],
"task_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"status": "IN_PROGRESS"
}
} - 400: Bad Request - The server could not understand the request due to invalid syntax.
- Content-Type:
application/json - Response Properties:
- Example:
- 401: Unauthorized - The client must authenticate itself to get the requested response.
- Content-Type:
application/json - Response Properties:
- Example:
- 500: Internal Server Error - The server has encountered a situation it doesn't know how to handle.
- Content-Type:
application/json - Response Properties:
- Example:
{
"message": "Internal Server Error"
} - 503: Service Unavailable
- Content-Type:
application/json - Response Properties:
- Example:
{
"message": "Service Unavailable. Please try again later."
} |