Skip to main content
GET
/
api
/
projects
/
public
List public projects
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/projects/public \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "projects": [
    {
      "id": 1,
      "name": "Water hammer detection",
      "description": "<string>",
      "created": "2019-07-21T17:32:28Z",
      "owner": "<string>",
      "publicUrl": "https://studio.edgeimpulse.com/public/40479/latest",
      "projectType": "kws",
      "pageViewCount": 123,
      "cloneCount": 123,
      "tags": [
        "FOMO",
        "birds"
      ],
      "ownerAvatar": "<string>",
      "totalSamplesCount": "<string>",
      "trainingAccuracy": 123,
      "testAccuracy": 123,
      "readme": {
        "markdown": "<string>",
        "html": "<string>"
      }
    }
  ],
  "totalProjectCount": 123,
  "error": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
limit
integer

Maximum number of results

​
offset
integer

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

​
project
string

Only include projects where the name or owner contains this string

​
projectTypes
string

Comma separated list of project types to filter on. Supported values are 'audio', 'object-detection', 'image', 'accelerometer', 'other'.

​
sort
string

Fields and order to sort query by Comma separated list of fields to sort query by. Prefix with a minus (-) sign to indicate descending order. Default order is ascending

Example:

"id,-name"

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
projects
object[]
required

Array with public projects

​
totalProjectCount
integer
required
​
error
string

Optional error description (set if 'success' was false)