The Platform API

Projects

Manage your videos, ask questions, and build applications with the Platform API. Explore the operations below for request details, responses, and examples.

Projects

Projects are the top-level container for videos, documents, alerts, and agent sessions.

GET/api/v1/projectsList user's projects

List user's projects

Send the request to https://platform.endlessai.com/api/v1/projects using your project key or user token.

POST/api/v1/projectsCreate project

Create project

Request body:

{ "name": "My Project", "description": "optional" }

GET/api/v1/projects/:projectIdGet project details

Get project details

Send the request to https://platform.endlessai.com/api/v1/projects/:projectId using your project key or user token.

PUT/api/v1/projects/:projectIdBetaUpdate project

Update project

Beta: this operation may change before it is final.

Request body (partial update):

{ "name": "New Name", "description": "Updated desc" }

DELETE/api/v1/projects/:projectIdDelete project

Delete project

Returns 204 No Content on success.

GET/api/v1/projects/:projectId/configGet project configuration

Get project configuration

Returns the project configuration, including analysis and detection settings.

POST/api/v1/projects/from-template/:templateIdBetaCreate project from template

Create project from template

Beta: this operation may change before it is final.

Send the request to https://platform.endlessai.com/api/v1/projects/from-template/:templateId using your project key or user token.

PUT/api/v1/projects/:projectId/stageBetaUpdate project stage

Update project stage

Beta: this operation may change before it is final.

Body: { "stage": "production" } — stages: created, calibrating, production

GET/api/v1/projects/:projectId/checklistBetaGet setup checklist

Get setup checklist

Beta: this operation may change before it is final.

Send the request to https://platform.endlessai.com/api/v1/projects/:projectId/checklist using your project key or user token.