{
    "expand_method": "ref",
    "shorturis": false
}

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/image!search?start=1&count=10"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "ParameterDescription": {
            "Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)",
            "Select": "Select one option. Options should pass only the \"Value\".",
            "Uri": "Absolute or relative URL, restricted to Locator(s) of the supplied URL if not null.   Up to a MAX_LENGTH in length.",
            "Array": "An indexed array of values with a length in the range MIN_COUNT to MAX_COUNT, inclusive.",
            "Boolean": "For true return type true or 1, for false type false or 0",
            "DateTimeISO8601": "ISO 8601 date time in the RFC 3339 format: YYYY-MM-DDThh:mm:ss.sTZD"
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "Text",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "Search all text fields",
                    "Type": "Varchar",
                    "MIN_CHARS": 1,
                    "MAX_CHARS": "INFINITY"
                },
                {
                    "Name": "SortMethod",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "Popular",
                    "Type": "Select",
                    "OPTIONS": [
                        "DateTaken",
                        "DateUploaded",
                        "Popular"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                },
                {
                    "Name": "SortDirection",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "Descending",
                    "Type": "Select",
                    "OPTIONS": [
                        "Ascending",
                        "Descending"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                },
                {
                    "Name": "Scope",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "The URI of an Album, Folder, Node, or User to search within",
                    "Type": "Uri",
                    "MAX_LENGTH": "INFINITY",
                    "Locator": []
                },
                {
                    "Name": "Keywords",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "Single keyword or JSON encoded array of keywords to search for",
                    "Type": "Array",
                    "ITEM_TYPE": "Varchar",
                    "MIN_COUNT": 1,
                    "MAX_COUNT": "INFINITY"
                },
                {
                    "Name": "Relevance",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": true,
                    "Description": "For text searches, prioritize relevant results over sort order",
                    "Type": "Boolean"
                },
                {
                    "Name": "DateTakenStart",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "Start Date to filter images by Date Taken",
                    "Type": "DateTimeISO8601"
                },
                {
                    "Name": "DateTakenEnd",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "End Date to filter images by Date Taken",
                    "Type": "DateTimeISO8601"
                },
                {
                    "Name": "DateUploadedStart",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "Start Date to filter images by Upload Date",
                    "Type": "DateTimeISO8601"
                },
                {
                    "Name": "DateUploadedEnd",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "End Date to filter images by Upload Date",
                    "Type": "DateTimeISO8601"
                },
                {
                    "Name": "Type",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Select",
                    "OPTIONS": [
                        "Image",
                        "Video"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Notes": [
            "_multiargs does not work at this endpoint"
        ]
    },
    "Response": {
        "Uri": "/api/v2/image!search?start=1&count=10",
        "Locator": "Image",
        "LocatorType": "Objects",
        "UriDescription": "Search for images",
        "EndpointType": "ImageSearch",
        "Pages": {
            "Total": 0,
            "Start": 1,
            "Count": 0,
            "RequestedCount": 10,
            "FirstPage": "/api/v2/image!search?start=1&count=10",
            "LastPage": "/api/v2/image!search?start=-9&count=10"
        },
        "Timing": {
            "Total": {
                "time": 0.02581,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}