Skip to main content
GET
/
api
/
{projectId}
/
versions
List versions
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/versions \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "nextVersion": 123,
  "versions": [
    {
      "id": 123,
      "version": 123,
      "description": "<string>",
      "bucket": {
        "path": "<string>",
        "id": 123,
        "name": "<string>",
        "organizationName": "<string>",
        "bucket": "<string>"
      },
      "created": "2023-11-07T05:31:56Z",
      "userId": 123,
      "userName": "<string>",
      "userPhoto": "<string>",
      "publicProjectId": 123,
      "publicProjectUrl": "<string>",
      "trainingAccuracy": 123,
      "testAccuracy": 123,
      "trainingmAP50": 123,
      "testmAP50": 123,
      "accuracyBasedOnImpulse": "<string>",
      "totalSamplesCount": "<string>"
    }
  ],
  "customLearnBlocks": [
    {
      "author": "<string>",
      "name": "<string>"
    }
  ],
  "runModelTestingWhileVersioning": true,
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.edgeimpulse.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
projectId
integer
required

Project ID

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
nextVersion
integer
required
​
versions
object[]
required
​
customLearnBlocks
object[]
required

If you have any custom learn blocks (e.g. blocks you pushed through Bring Your Own Model), then these are listed here. We use these to show a warning in the UI that these blocks will also be available in a public version.

​
runModelTestingWhileVersioning
boolean
required

Whether the 'Run model testing while versioning' checkbox should be enabled.

​
error
string

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