PIpics
Assets

Search for assets

post/images/search

Request

  • Base URL
    https://api.pics.io
  • Auth
    HTTP bearer

Request body

fromnumber

A cursor for use in pagination. Defines initial place in the list to return assets from

sizenumber

A limit on the number of assets to be returned. Keep it below 50.

tagIdstring

Collection id to recursively search in

inboxIdstring

Inbox id to recursively search in

lightboardIdstring

Lightboard id to recursively search in

type'images' | 'video' | 'audio' | 'text' | 'pdf' | 'sketch' | 'raw' | 'photoshop'

Filter assets by type

textstring

Text query to search. Search fields managed by searchIn parameter

searchIn'name' | 'title' | 'description' | 'keywords' | 'meta' | 'content' | 'tagName'

Specifies field to search text at

flag'flagged' | 'unflagged' | 'rejected'

Filter assets by flag

ratingnumber

Filter assets by stars rating

color'yellow' | 'orange' | 'red' | 'green' | 'aqua' | 'blue' | 'purple' | 'nocolor'

Filter assets by color

createdAt'today' | 'yesterday' | 'lastweek' | 'lastmonth' | 'last90days' | 'custom'

Search by creation date. May be of predefined aliases or specific range

              Custom date format is similar to HTTP Range header `/^([-0-9]*)_([-0-9]*)$/)`. 
              Contains of two timestamps (milliseconds) separated by underscode symbol.
              Any timestamp can be postponed to allow specify 'before' and 'after' date ranges.  

              Using alias: `createdAt: today`  
              Between two dates: `createdAt: 1450650500000_1460650500000`  
              After date: `createdAt: 1450650500000_`  
              Before date: `createdAt: _1460650500000`

Example request

{
  "type": "images",
  "text": "my text to search",
  "searchIn": "name,title,description,keywords,meta,content,tagName",
  "flag": "flagged",
  "rating": 5,
  "color": "green",
  "createdAt": "1450650500000_1460650500000",
  "productSelection": {
    "layer": "master",
    "recordState": "draft",
    "productIds": [
      "6a27eb2b4ee225366f4657c3"
    ],
    "variantIds": [
      "6a27eb2b4ee225366f4657e5"
    ]
  }
}

Response

Ok

Changes

No recorded changes to this operation across all 1 revision of this API.