API reference

This API reference provides detailed technical information on the endpoints, query parameters, and responses of Flow.

Query

The URL structure for requests is as follows:

http://DOMAIN:PORT/API/CORES/COLLECTION/REQUEST_HANDLER?QUERY

This is a concrete example:

http://localhost:8983/api/cores/my-collection/select?q=*:*

Response

The response generally contains a responseHeader with information to the query and the response that contains the actual search results.

{  
  "responseHeader": {
    "status": 0, // success (0) or error processing
    "QTime": 1 // query time in ms
  },
  "response": {
    "numFound": 7, // number of matches
    "start": 0, // result offset (used for pagination)
    "numFoundExact": true,
    "docs": [ // query results
      {
        "id": "111", // unique document identifier
        "image": "http://localhost/image.jpg",
        "labels": [ // multi-valued field
          "architecture"
        ]      
      }      
    ]
  }
}