Transform

Add a transform with the given site_id, template_id, name and config. It returns the created object including fields like id, created_at, updated_at.

post

Create a new transform.

Authorizations

authorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Body

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

post

/gateway/v1/transform

POST /gateway/v1/transform HTTP/1.1
Host: p01-api.observo.ai
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 430

{
  "transform": {
    "id": 1,
    "siteId": 1,
    "templateId": 1,
    "templateVersion": 1,
    "name": "text",
    "description": "text",
    "pipelineId": 1,
    "config": {},
    "status": "NS_DEFAULT",
    "created": "2025-11-29T05:57:23.534Z",
    "updated": "2025-11-29T05:57:23.534Z",
    "createdBy": "text",
    "updatedBy": "text",
    "isTransformGroup": true,
    "origin": "NODE_ORIGIN_DEFAULT",
    "templateName": "text",
    "processorType": "PROCESSOR_TYPE_UNSPECIFIED",
    "siteFilenames": [
      "text"
    ],
    "userVisible": true
  }
}

{
  "status": {
    "code": "OK",
    "errorMessage": "text",
    "userMessageCode": "DEFAULT"
  },
  "transform": {
    "id": 1,
    "siteId": 1,
    "templateId": 1,
    "templateVersion": 1,
    "name": "text",
    "description": "text",
    "pipelineId": 1,
    "config": {},
    "status": "NS_DEFAULT",
    "created": "2025-11-29T05:57:23.534Z",
    "updated": "2025-11-29T05:57:23.534Z",
    "createdBy": "text",
    "updatedBy": "text",
    "isTransformGroup": true,
    "origin": "NODE_ORIGIN_DEFAULT",
    "templateName": "text",
    "processorType": "PROCESSOR_TYPE_UNSPECIFIED",
    "siteFilenames": [
      "text"
    ],
    "userVisible": true
  }
}

List all transform templates. If site_ids are specified, returns only templates for transforms in the given sites. If include_config_format is set, will return config formats for each of the templates.

get

List available transform templates.

Authorizations

authorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Query parameters

includeConfigFormatbooleanOptional

Whether to include config format in return value.

namesstring[]Optional

Filter on transform template name. This is not user display name.

versionsinteger · uint64[]Optional

Filter on transform template versions.

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

/gateway/v1/transform-templates

GET /gateway/v1/transform-templates HTTP/1.1
Host: p01-api.observo.ai
authorization: YOUR_API_KEY
Accept: */*

{
  "transformTemplates": [
    {
      "id": 1,
      "name": "text",
      "processorType": "PROCESSOR_TYPE_UNSPECIFIED",
      "configFormat": {},
      "isTransformGroup": true,
      "description": "text",
      "created": "2025-11-29T05:57:23.534Z",
      "updated": "2025-11-29T05:57:23.534Z",
      "displayName": "text",
      "category": "DEFAULT",
      "version": 1
    }
  ],
  "status": {
    "code": "OK",
    "errorMessage": "text",
    "userMessageCode": "DEFAULT"
  }
}

List all transforms, filtered based on site_ids, transform_ids and status. This API is paginated and returns values [offset, offset + page_size). site_ids is mandatory. Transform's config is returned if include_config is set. Filters out deleted transforms, unless transform_ids or statuses types provided.

get

Create multiple transforms in batch.

Authorizations

authorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Query parameters

siteIdsinteger · uint64[]Optional

pipelineIdsinteger · uint64[]Optional

transformIdsinteger · uint64[]Optional

templateIdsinteger · uint64[]Optional

includeConfigbooleanOptional

Whether to include config in return value.

pagination.offsetinteger · int64Optional

pagination.limitinteger · int64Optional

pagination.totalCountinteger · int64Optional

pagination.ordering.fieldNamestringOptional

pagination.ordering.descendingbooleanOptional

namesstring[]Optional

Filter on transform display name.

includeHiddenbooleanOptional

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

/gateway/v1/transforms

GET /gateway/v1/transforms HTTP/1.1
Host: p01-api.observo.ai
authorization: YOUR_API_KEY
Accept: */*

{
  "status": {
    "code": "OK",
    "errorMessage": "text",
    "userMessageCode": "DEFAULT"
  },
  "transforms": [
    {
      "id": 1,
      "siteId": 1,
      "templateId": 1,
      "templateVersion": 1,
      "name": "text",
      "description": "text",
      "pipelineId": 1,
      "config": {},
      "status": "NS_DEFAULT",
      "created": "2025-11-29T05:57:23.534Z",
      "updated": "2025-11-29T05:57:23.534Z",
      "createdBy": "text",
      "updatedBy": "text",
      "isTransformGroup": true,
      "origin": "NODE_ORIGIN_DEFAULT",
      "templateName": "text",
      "processorType": "PROCESSOR_TYPE_UNSPECIFIED",
      "siteFilenames": [
        "text"
      ],
      "userVisible": true
    }
  ],
  "pagination": {
    "offset": 1,
    "limit": 1,
    "totalCount": 1,
    "ordering": {
      "fieldName": "text",
      "descending": true
    }
  }
}

Add a set of transforms, each with the given site_id, template_id, name and config. It takes a list of transforms and the created transforms in the same order. The created object returned includes fields like id, created_at, updated_at. Either all creates succeed or all of them fail. If all fail, then the returned list is empty.

post

Create multiple transforms in batch.

Authorizations

authorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Body

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

post

/gateway/v1/transforms

POST /gateway/v1/transforms HTTP/1.1
Host: p01-api.observo.ai
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 433

{
  "transforms": [
    {
      "id": 1,
      "siteId": 1,
      "templateId": 1,
      "templateVersion": 1,
      "name": "text",
      "description": "text",
      "pipelineId": 1,
      "config": {},
      "status": "NS_DEFAULT",
      "created": "2025-11-29T05:57:23.534Z",
      "updated": "2025-11-29T05:57:23.534Z",
      "createdBy": "text",
      "updatedBy": "text",
      "isTransformGroup": true,
      "origin": "NODE_ORIGIN_DEFAULT",
      "templateName": "text",
      "processorType": "PROCESSOR_TYPE_UNSPECIFIED",
      "siteFilenames": [
        "text"
      ],
      "userVisible": true
    }
  ]
}

{
  "transform": [
    {
      "id": 1,
      "siteId": 1,
      "templateId": 1,
      "templateVersion": 1,
      "name": "text",
      "description": "text",
      "pipelineId": 1,
      "config": {},
      "status": "NS_DEFAULT",
      "created": "2025-11-29T05:57:23.534Z",
      "updated": "2025-11-29T05:57:23.534Z",
      "createdBy": "text",
      "updatedBy": "text",
      "isTransformGroup": true,
      "origin": "NODE_ORIGIN_DEFAULT",
      "templateName": "text",
      "processorType": "PROCESSOR_TYPE_UNSPECIFIED",
      "siteFilenames": [
        "text"
      ],
      "userVisible": true
    }
  ],
  "statuses": [
    {
      "code": "OK",
      "errorMessage": "text",
      "userMessageCode": "DEFAULT"
    }
  ]
}

PreviousSource NextModels

Last updated 4 months ago

Was this helpful?