The Platform API

Report Types

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

Report Types

Templates that fix the sections of a job's report. A job with output_contract: "report" fills the report type it names, so every result has the same shape.

GET/api/v1/projects/:projectId/report-typesList report types

List report types

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

POST/api/v1/projects/:projectId/report-typesCreate or update a report type

Create or update a report type

Saved by name: posting an existing name updates it. Each section has a title, a format of text or table (a table needs columns), and optional guidance and required. Returns 201.

{
    "name": "Daily opening report",
    "description": "One report per store per morning",
    "structure": {
      "intro": "Summarise how the store opened.",
      "verdict_hint": "On time / Late, with the opening time",
      "sections": [
        { "title": "Summary", "format": "text", "required": true },
        {
          "title": "Checklist",
          "format": "table",
          "columns": [
            { "key": "item", "label": "Item" },
            { "key": "status", "label": "Status" },
            { "key": "time", "label": "Time" }
          ]
        }
      ]
    }
  }

GET/api/v1/projects/:projectId/report-types/:reportTypeIdGet a report type

Get a report type

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

DELETE/api/v1/projects/:projectId/report-types/:reportTypeIdDelete a report type

Delete a report type

Returns 204. Jobs that used it keep running, but their results no longer follow its sections.