search_resources
Search and retrieve visual resources with filters for orientation, content type, license, and more. Use query parameters to refine results based on specific criteria.
Instructions
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:
- Content-Type:
- 400: Bad Request - The server could not understand the request due to invalid syntax.
- Content-Type:
application/json
- Response Properties:
- Example:
- Content-Type:
- 401: Unauthorized - The client must authenticate itself to get the requested response.
- Content-Type:
application/json
- Response Properties:
- Example:
- Content-Type:
- 403: Forbidden - The client does not have permission to access the requested resource.
- Content-Type:
application/json
- Response Properties:
- Example:
- Content-Type:
- 404: Not Found - The server can not find the requested resource.
- Content-Type:
application/json
- Response Properties:
- Example:
- Content-Type:
- 503: Service Unavailable
- Content-Type:
application/json
- Response Properties:
- Example:
- Content-Type:
Input Schema
Name | Required | Description | Default |
---|---|---|---|
Accept-Language | No | Specifies the search query language using the ISO 639-1 (2-letter language code) and the ISO 3166-1 (2-letter country code) for language variants. The API will use "en-US" as a default language for processing if a code is not provided, or does not exist. | |
filters[ai-generated][excluded] | No | Excludes AI-generated images from the results. Set to 1 to exclude, 0 to include. | |
filters[ai-generated][only] | No | Filters results to only include AI-generated images. Set to 1 to include only AI-generated images, 0 to include all images. | |
filters[author] | No | Filters results to include resources by a specific author, identified by their author ID. | |
filters[color] | No | Filters results by the predominant color in the resources. | |
filters[content_type][photo] | No | Filters results to only include resources of type photo. Set to 1 to enable, 0 to disable. | |
filters[content_type][psd] | No | Filters results to only include resources of type PSD (Photoshop Document). Set to 1 to enable, 0 to disable. | |
filters[content_type][vector] | No | Filters results to only include resources of type vector. Set to 1 to enable, 0 to disable. | |
filters[ids] | No | 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. | |
filters[license][freemium] | No | Filters results to only include resources with a freemium license. Set to 1 to enable, 0 to disable. | |
filters[license][premium] | No | Filters results to only include resources with a premium license. Set to 1 to enable, 0 to disable. | |
filters[orientation][landscape] | No | Filters results to only include resources with a landscape orientation. Set to 1 to enable, 0 to disable. | |
filters[orientation][panoramic] | No | Filters results to only include resources with a panoramic orientation. Set to 1 to enable, 0 to disable. | |
filters[orientation][portrait] | No | Filters results to only include resources with a portrait orientation. Set to 1 to enable, 0 to disable. | |
filters[orientation][square] | No | Filters results to only include resources with a square orientation. Set to 1 to enable, 0 to disable. | |
filters[people][age] | No | Filter by age of the people | |
filters[people][ethnicity] | No | Filter by ethnicity of the people | |
filters[people][exclude] | No | Filter by excluded people | |
filters[people][gender] | No | Filter by gender of the people | |
filters[people][include] | No | Filter by included people | |
filters[people][number] | No | Filter by number of people | |
filters[period] | No | Filters results based on the time period in which the resources were added. | |
filters[psd][type] | No | File type for psd | |
filters[vector][style] | No | Style type for vectors, ignored if content_type exists and it is not vector | |
filters[vector][type] | No | File type for vectors | |
limit | No | Limit results per page. It must be greater than 0. | |
order | No | 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. | relevance |
page | No | Page number. It must be greater than 0 and less than or equal to 100. | |
term | No | 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 |