Skip to main content
API docs by Redocly

Tecton HTTP API (1.0)

License: Proprietary

Tecton provides a HTTP API to read feature data and perform administrative tasks. Please see the individual services below for more information on their function and how to use them.

Postman Definitions: You can also load our API definitions as a Postman Collection for use in Postman.

Feature Service

Tecton provides a low-latency feature server that exposes HTTP endpoints to retrieve feature values and metadata from the online store. These endpoints are typically used during model predictions. The feature servers retrieve data from the online store and perform any additional aggregations and filtering as necessary.

GetFeatures

Get Features API to retrieve feature values from Tecton's online store

Authorizations:
(BearerTecton-key)
Request Body schema: application/json
required
object (GetFeaturesParameters)

Parameters for get-features.

Exactly one of featureServiceName and featureServiceId must be set. Next ID: 19

featureServiceId
string

FeatureService ID. Exactly one of this field and featureServiceName must be set.

featureServiceName
string

FeatureService name. Exactly one of this field and featureServiceId must be set.

workspaceName
string
joinKeyMap
object

Join keys used for Batch and Stream FeatureViews.

The key of this map is the join key name and the value is the join key value for this request. The values are encoded as follows:

  • For string keys, the value should be a string.
  • For int64 keys, the value should be a string of the decimal representation of the integer.
requestContextMap
object

Request context used for On-Demand Feature Views.

The key of this map is the request context key name and the value is the request context value for this request. The values are encoded as follows:

  • For string values, the value should be a string.
  • For int64 values, the value should be a string of the decimal representation of the integer.
  • For double values, the value should be a number.
object (MetadataOptions)

Options for retrieving additional metadata about the feature values.

allowPartialResults
boolean
Default: "false"

Whether incomplete results should be returned when the Online Feature Store size limit has been exceeded for this request. If this is not true, then the response will be an error in this case. This is different from allowing partial results due to a latency budget, which is controlled with the request_options.latency_budget_ms field.

This is an advanced option and should only be set after consulting with the Tecton team.

object (Request level options to control feature server behavior)

Responses

Request samples

Content type
application/json
{
  • "params": {
    • "featureServiceName": "fraud_detection_feature_service",
    • "workspaceName": "prod",
    • "joinKeyMap": {
      • "user_id": "A123",
      • "ad_id": "5417"
      },
    • "requestContextMap": {
      • "amount": 500
      },
    • "metadataOptions": {
      • "includeSloInfo": true,
      • "includeEffectiveTimes": true,
      • "includeNames": true,
      • "includeDataTypes": true,
      • "includeServingStatus": true
      }
    }
}

Response samples

Content type
application/json
{
  • "result": {
    • "features": [
      • true,
      • null,
      • null,
      • null,
      • "669",
      • 58.349395161290275,
      • 40.13619047619047,
      • 59.59825688073392,
      • 28941.299999999977,
      • 842.8599999999999,
      • 90946.93999999996,
      • [
        • "892054b9598370dce846bb6e4b5805a1",
        • "cc9f13814a736160984bc9896222e4d9",
        • "43a9799c961de6ebb22c122d8c7eb340"
        ]
      ]
    },
  • "metadata": {
    • "features": [
      • {
        • "name": "transaction_amount_is_higher_than_average.transaction_amount_is_higher_than_average",
        • "dataType": {
          • "type": "boolean"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "merchant_fraud_rate.is_fraud_mean_1d_1d",
        • "effectiveTime": "2023-05-03T00:00:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "MISSING_DATA"
        },
      • {
        • "name": "merchant_fraud_rate.is_fraud_mean_30d_1d",
        • "effectiveTime": "2023-05-03T00:00:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "MISSING_DATA"
        },
      • {
        • "name": "merchant_fraud_rate.is_fraud_mean_90d_1d",
        • "effectiveTime": "2023-05-03T00:00:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "MISSING_DATA"
        },
      • {
        • "name": "user_distinct_merchant_transaction_count_30d.distinct_merchant_transaction_count_30d",
        • "effectiveTime": "2023-05-04T00:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "user_transaction_amount_metrics.amt_mean_1d_10m",
        • "effectiveTime": "2023-05-04T15:50:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "user_transaction_amount_metrics.amt_mean_1h_10m",
        • "effectiveTime": "2023-05-04T15:50:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "user_transaction_amount_metrics.amt_mean_3d_10m",
        • "effectiveTime": "2023-05-04T15:50:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "user_transaction_amount_metrics.amt_sum_1d_10m",
        • "effectiveTime": "2023-05-04T15:50:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "user_transaction_amount_metrics.amt_sum_1h_10m",
        • "effectiveTime": "2023-05-04T15:50:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "user_transaction_amount_metrics.amt_sum_3d_10m",
        • "effectiveTime": "2023-05-04T15:50:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "user_transaction_counts.transaction_id_last_3_1d_1d",
        • "effectiveTime": "2023-05-03T00:00:00Z",
        • "dataType": {
          • "type": "array",
          • "elementType": {
            • "type": "string"
            }
          },
        • "status": "PRESENT"
        }
      ],
    • "sloInfo": {
      • "sloEligible": true,
      • "sloServerTimeSeconds": 0.015835683,
      • "dynamodbResponseSizeBytes": 23722,
      • "serverTimeSeconds": 0.016889888,
      • "storeMaxLatency": 0.02687345,
      • "storeResponseSizeBytes": 23722
      }
    }
}

GetFeaturesBatch

Batch GetFeatures API to retrieve feature values in batch from Tecton's online store. The maximum batch size for a single batch request is 10. NOTE: This endpoint is only for feature services with Redis feature views.

Authorizations:
(BearerTecton-key)
Request Body schema: application/json
required
object (GetFeaturesBatchParameters)

Parameters for get-features-batch.

Exactly one of featureServiceName and featureServiceId must be set.

featureServiceId
string

FeatureService ID. Exactly one of this field and featureServiceName must be set.

featureServiceName
string

FeatureService name. Exactly one of this field and featureServiceId must be set.

workspaceName
string
Array of objects (GetFeaturesBatchRequestData)

Contains individual GetFeatures request parameters in an array. Each array element contains join keys and request contexts corresponding to a single GetFeatures request. The response will return results to each GetFeatures request in the same order that they are specified in the array.

object (MetadataOptions)

Options for retrieving additional metadata about the feature values.

object (Request level options to control feature server behavior)

Responses

Request samples

Content type
application/json
{
  • "params": {
    • "featureServiceName": "fraud_detection_feature_service",
    • "requestData": [
      • {
        • "joinKeyMap": {
          • "user_uuid": "6c423390-9a64-52c8-9bb3-bbb108c74198"
          },
        • "requestContextMap": {
          • "amount": 2000
          }
        },
      • {
        • "joinKeyMap": {
          • "user_uuid": "6c423390-9a64-52c8-9bb3-bbb108c74198"
          },
        • "requestContextMap": {
          • "amount": 500
          }
        }
      ],
    • "workspaceName": "prod",
    • "metadataOptions": {
      • "includeSloInfo": true,
      • "includeEffectiveTimes": true,
      • "includeNames": true,
      • "includeDataTypes": true,
      • "includeServingStatus": true
      }
    }
}

Response samples

Content type
application/json
{
  • "result": [
    • {
      • "features": [
        • null,
        • null,
        • null,
        • "37",
        • "3",
        • "138",
        • "307",
        • "37",
        • "3",
        • "138"
        ]
      },
    • {
      • "features": [
        • null,
        • null,
        • null,
        • "43",
        • null,
        • "128",
        • "254",
        • "43",
        • null,
        • "128"
        ]
      }
    ],
  • "metadata": {
    • "features": [
      • {
        • "name": "user_ad_impression_counts.impression_count_1d_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "MISSING_DATA",
          • "MISSING_DATA"
          ]
        },
      • {
        • "name": "user_ad_impression_counts.impression_count_1h_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "MISSING_DATA",
          • "MISSING_DATA"
          ]
        },
      • {
        • "name": "user_ad_impression_counts.impression_count_3d_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "MISSING_DATA",
          • "MISSING_DATA"
          ]
        },
      • {
        • "name": "user_click_counts.clicked_count_1d_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "PRESENT",
          • "PRESENT"
          ]
        },
      • {
        • "name": "user_click_counts.clicked_count_1h_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "PRESENT",
          • "MISSING_DATA"
          ]
        },
      • {
        • "name": "user_click_counts.clicked_count_3d_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "PRESENT",
          • "PRESENT"
          ]
        },
      • {
        • "name": "user_distinct_ad_count_7d.distinct_ad_count",
        • "effectiveTime": "2023-05-26T00:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "PRESENT",
          • "PRESENT"
          ]
        },
      • {
        • "name": "user_impression_counts.impression_count_1d_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "PRESENT",
          • "PRESENT"
          ]
        },
      • {
        • "name": "user_impression_counts.impression_count_1h_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "PRESENT",
          • "MISSING_DATA"
          ]
        },
      • {
        • "name": "user_impression_counts.impression_count_3d_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "PRESENT",
          • "PRESENT"
          ]
        }
      ],
    • "sloInfo": [
      • {
        • "sloEligible": true,
        • "sloServerTimeSeconds": 0.001231726,
        • "dynamodbResponseSizeBytes": 1873,
        • "serverTimeSeconds": 0.001231726,
        • "storeMaxLatency": 0.000877174,
        • "storeResponseSizeBytes": 1873
        },
      • {
        • "sloEligible": true,
        • "sloServerTimeSeconds": 0.001329688,
        • "dynamodbResponseSizeBytes": 1937,
        • "serverTimeSeconds": 0.001329688,
        • "storeMaxLatency": 0.000791104,
        • "storeResponseSizeBytes": 1937
        }
      ],
    • "batchSloInfo": {
      • "sloEligible": true,
      • "sloServerTimeSeconds": 0.001329688,
      • "serverTimeSeconds": 0.00181146,
      • "storeMaxLatency": 0.000877174
      }
    }
}

Metadata

Get Metadata about the feature service from Tecton

Authorizations:
(BearerTecton-key)
Request Body schema: application/json
required

Returns metadata about a FeatureService, including the schema for join keys and request context, as well as the in-order output schema of returned feature values.

object (FeatureServiceLocator)
featureServiceId
string

FeatureService ID. Exactly one of this field and featureServiceName must be set.

featureServiceName
string

FeatureService name. Exactly one of this field and featureServiceId must be set.

workspaceName
string

Workspace name.

Responses

Request samples

Content type
application/json
{
  • "params": {
    • "featureServiceName": "fraud_detection_feature_service",
    • "workspaceName": "prod"
    }
}

Response samples

Content type
application/json
{
  • "featureServiceType": "DEFAULT",
  • "inputJoinKeys": [
    • {
      • "name": "user_id",
      • "dataType": {
        • "type": "string"
        }
      },
    • {
      • "name": "merchant",
      • "dataType": {
        • "type": "string"
        }
      }
    ],
  • "inputRequestContextKeys": [
    • {
      • "name": "amt",
      • "dataType": {
        • "type": "float64"
        }
      }
    ],
  • "featureValues": [
    • {
      • "name": "transaction_amount_is_higher_than_average.transaction_amount_is_higher_than_average",
      • "dataType": {
        • "type": "boolean"
        }
      },
    • {
      • "name": "merchant_fraud_rate.is_fraud_mean_1d_1d",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "merchant_fraud_rate.is_fraud_mean_30d_1d",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "merchant_fraud_rate.is_fraud_mean_90d_1d",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "user_distinct_merchant_transaction_count_30d.distinct_merchant_transaction_count_30d",
      • "dataType": {
        • "type": "int64"
        }
      },
    • {
      • "name": "user_transaction_amount_metrics.amt_mean_1d_10m",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "user_transaction_amount_metrics.amt_mean_1h_10m",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "user_transaction_amount_metrics.amt_mean_3d_10m",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "user_transaction_amount_metrics.amt_sum_1d_10m",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "user_transaction_amount_metrics.amt_sum_1h_10m",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "user_transaction_amount_metrics.amt_sum_3d_10m",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "user_transaction_counts.transaction_id_last_3_1d_1d",
      • "dataType": {
        • "type": "array",
        • "elementType": {
          • "type": "string"
          }
        }
      }
    ]
}

Ingestion Service

The Ingestion Service, or Stream Ingest API, is an endpoint to ingest or update features in the Tecton Feature Store with sub-second latency. Records sent to the Stream Ingest API are immediately written to the Tecton Feature Store and made available for training and inference. The Stream Ingest API seamlessly integrates with Rift, Tecton's managed compute engine, to optionally execute feature transformations.

Ingest records

Submit feature data as records to be written into the Tecton Feature Store

Learn more about Tecton's Stream Ingest API
Authorizations:
Tecton-key
Request Body schema: application/json
required
workspaceName
required
string

Workspace containing the target Tecton Feature Store. Snake case workspace_name also accepted.

dryRun
required
boolean

Dry-run flag. Enable to issue a request without persisting data to online or offline stores.Snake-case dry_run also accepted.

records
required
object

Each key-value pair in this records object maps a stream source name to an array of data records to be ingested. Refer to the sample request payload in the right pane to see the expected record format. Note that each record is an object with a single record key, and a value object containing all the column names and corresponding values to be ingested.

Limits: Each stream source came can be mapped to a maximum of 10 records to be ingested.

Responses

Request samples

Content type
application/json
{
  • "workspaceName": "my_workspace",
  • "dryRun": false,
  • "records": {
    • "stream_source_1": [
      • {
        • "record": {
          • "timestamp": "2024-01-01T00:00:01Z",
          • "user_id": "123",
          • "value": 1
          }
        },
      • {
        • "record": {
          • "timestamp": "2024-01-01T00:00:02Z",
          • "user_id": "123",
          • "value": 2
          }
        }
      ],
    • "stream_source_2": [
      • {
        • "record": {
          • "timestamp": "2024-01-01T00:00:03Z",
          • "user_id": "456",
          • "value": 3
          }
        },
      • {
        • "record": {
          • "timestamp": "2024-01-01T00:00:04Z",
          • "user_id": "456",
          • "value": 4
          }
        }
      ]
    }
}

Response samples

Content type
application/json
{
  • "workspaceName": "my_workspace",
  • "ingestMetrics": {
    • "featureViewIngestMetrics": [
      • {
        • "featureViewName": "my_feature_view",
        • "onlineRecordIngestCount": "10",
        • "featureViewId": "12341234123412341234123412341234"
        }
      ]
    }
}

SCIM Service

Tecton's SCIM implementation allows you to control provisioning of users, service accounts, groups, group memberships and access controls from within your Identity Provider so that you can manage onboarding and guarantee off-boarding through your existing processes.

The SCIM API contains resources for users, groups and service accounts. While group memberships are returned on all resources, they are modifiable on the Groups resources. Role assignments are manageable directly on the Users, Groups and Service Accounts resources.

⚠️ Private Preview

Note that this API is currently in Private Preview. To learn more, please contact your Tecton representative.

Groups - Get all groups

Retrieve information on all Tecton Groups. Note that role assignments and members are not returned for each group (call "Get a group" instead). Implements RFC-7644 section 3.4.2.

Authorizations:
(Bearer/AdminTecton-key/Admin)
query Parameters
filter
string

An optional filter. Filtering by displayName with the equality operator is the only supported filter (e.g. displayName eq engineering). See the RFC-7644 section 3.4.2.2 for more information about available filters.

startIndex
integer <int64>

This represents the 1-based index of the first query result. A value less than 1 SHALL be interpreted as 1. Default is 1. See here for information on pagination.

count
integer <int64>

Specifies the desired maximum number of query results per page. Non-negative integer. Less than 0 is treated as 0. No default value.

sortBy
string

Sorting is optional. See here for more information on this field.

sortOrder
string

Allowed values are ascending and descending. Defaults to ascending.

Responses

Response samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "startIndex": 0,
  • "itemsPerPage": 0,
  • "totalResults": 0,
  • "Resources": [
    • {
      • "schemas": [
        • "string"
        ],
      • "id": "string",
      • "meta": {
        • "resourceType": "string",
        • "created": "string",
        • "lastModified": "string"
        },
      • "displayName": "string",
      • "urn:ietf:params:scim:schemas:extension:tecton:1.0:Group": {
        • "description": "string",
        • "idpMappingNames": [
          • "string"
          ]
        }
      }
    ]
}

Groups - Create a group

Create a new group. Note that displayName must be unique. See: Creating Resources.

Authorizations:
(Bearer/AdminTecton-key/Admin)
Request Body schema: application/json
required
schemas
Array of strings

Expected to be ["urn:ietf:params:scim:schemas:core:2.0:Group"].

object (scimResourceMeta)

A complex attribute containing resource metadata. This is optional on requests. See the specification.

displayName
string

A human-readable name for the Group. It must be unique.

Array of objects (scimAttributeMember)

A list of members of the Group.

Array of objects (scimAttributeRole)

The roles directly assigned to the group.

object (scimGroupExtension)

Responses

Request samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "meta": {
    • "resourceType": "string",
    • "created": "string",
    • "lastModified": "string"
    },
  • "displayName": "string",
  • "members": [
    • {
      • "type": "string",
      • "display": "string",
      • "value": "string"
      }
    ],
  • "roles": [
    • {
      • "type": "string",
      • "value": "string"
      }
    ],
  • "urn:ietf:params:scim:schemas:extension:tecton:1.0:Group": {
    • "description": "string",
    • "idpMappingNames": [
      • "string"
      ]
    }
}

Response samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "id": "string",
  • "meta": {
    • "resourceType": "string",
    • "created": "string",
    • "lastModified": "string"
    },
  • "displayName": "string",
  • "members": [
    • {
      • "type": "string",
      • "display": "string",
      • "value": "string"
      }
    ],
  • "roles": [
    • {
      • "type": "string",
      • "value": "string"
      }
    ],
  • "urn:ietf:params:scim:schemas:extension:tecton:1.0:Group": {
    • "description": "string",
    • "idpMappingNames": [
      • "string"
      ]
    }
}

Groups - Get a group

Retrieve information on a Tecton Group. Implements RFC-7644 section 3.4.1.

Authorizations:
(Bearer/AdminTecton-key/Admin)
path Parameters
id
required
string

A unique identifier for the Group as defined by Tecton.

Responses

Response samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "id": "string",
  • "meta": {
    • "resourceType": "string",
    • "created": "string",
    • "lastModified": "string"
    },
  • "displayName": "string",
  • "members": [
    • {
      • "type": "string",
      • "display": "string",
      • "value": "string"
      }
    ],
  • "roles": [
    • {
      • "type": "string",
      • "value": "string"
      }
    ],
  • "urn:ietf:params:scim:schemas:extension:tecton:1.0:Group": {
    • "description": "string",
    • "idpMappingNames": [
      • "string"
      ]
    }
}

Groups - Delete a group

See: Deleting Resources.

Authorizations:
(Bearer/AdminTecton-key/Admin)
path Parameters
id
required
string

A unique identifier for the Group as defined by Tecton.

Responses

Response samples

Content type
application/json
{ }

Groups - Replace a group

Update a Group (i.e. update their displayName, description, members and/or roles). See: Replacing with PUT.

Authorizations:
(Bearer/AdminTecton-key/Admin)
path Parameters
id
required
string

A unique identifier for the Group as defined by Tecton.

Request Body schema: application/json
required
schemas
Array of strings

Expected to be ["urn:ietf:params:scim:schemas:core:2.0:Group"].

object (scimResourceMeta)

A complex attribute containing resource metadata. This is optional on requests. See the specification.

displayName
string

A human-readable name for the Group. It must be unique.

Array of objects (scimAttributeMember)

A list of members of the Group.

Array of objects (scimAttributeRole)

The roles directly assigned to the group.

object (scimGroupExtension)

Responses

Request samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "meta": {
    • "resourceType": "string",
    • "created": "string",
    • "lastModified": "string"
    },
  • "displayName": "string",
  • "members": [
    • {
      • "type": "string",
      • "display": "string",
      • "value": "string"
      }
    ],
  • "roles": [
    • {
      • "type": "string",
      • "value": "string"
      }
    ],
  • "urn:ietf:params:scim:schemas:extension:tecton:1.0:Group": {
    • "description": "string",
    • "idpMappingNames": [
      • "string"
      ]
    }
}

Response samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "id": "string",
  • "meta": {
    • "resourceType": "string",
    • "created": "string",
    • "lastModified": "string"
    },
  • "displayName": "string",
  • "members": [
    • {
      • "type": "string",
      • "display": "string",
      • "value": "string"
      }
    ],
  • "roles": [
    • {
      • "type": "string",
      • "value": "string"
      }
    ],
  • "urn:ietf:params:scim:schemas:extension:tecton:1.0:Group": {
    • "description": "string",
    • "idpMappingNames": [
      • "string"
      ]
    }
}

Service Accounts - Get all service accounts

Note that role assignments and memberships are not returned for each service account (call "Get a service account" instead). See: Query Resources.

Authorizations:
(Bearer/AdminTecton-key/Admin)
query Parameters
filter
string

An optional filter. Filtering by name with the equality operator is the only supported filter (e.g. name eq fraudRiskApp). See the RFC-7644 section 3.4.2.2 for more information about available filters.

startIndex
integer <int64>

This represents the 1-based index of the first query result. A value less than 1 SHALL be interpreted as 1. Default is 1. See here for information on pagination.

count
integer <int64>

Specifies the desired maximum number of query results per page. Non-negative integer. Less than 0 is treated as 0. No default value.

sortBy
string

Sorting is optional. See here for more information on this field.

sortOrder
string

Allowed values are ascending and descending. Defaults to ascending.

Responses

Response samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "startIndex": 0,
  • "itemsPerPage": 0,
  • "totalResults": 0,
  • "Resources": [
    • {
      • "schemas": [
        • "string"
        ],
      • "id": "string",
      • "meta": {
        • "resourceType": "string",
        • "created": "string",
        • "lastModified": "string"
        },
      • "name": "string",
      • "active": true,
      • "description": "string"
      }
    ]
}

Service Accounts - Create a service account

Create a new Service Account. Note that the name must be unique. Group memberships must be set after the service account is created. See: Creating Resources.

Authorizations:
(Bearer/AdminTecton-key/Admin)
Request Body schema: application/json
required
schemas
Array of strings

Expected to be ["urn:ietf:params:scim:schemas:tecton:1.0:ServiceAccount"].

object (scimResourceMeta)

A complex attribute containing resource metadata. This is optional on requests. See the specification.

name
string

The Service Account's name. The name must be unique. It is editable.

active
boolean

Whether the Service Account is active or not. Setting a Service Account as inactive will preserve their group memberships and role assignments. Inactive Service Accounts can not call Tecton APIs. Inactive Service Accounts may be reactivated by setting active to true.

description
string

Text to describe the Service Account, typically what the Service Account is used for.

Array of objects (scimAttributeRole)

The roles directly assigned to the service account.

Responses

Request samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "meta": {
    • "resourceType": "string",
    • "created": "string",
    • "lastModified": "string"
    },
  • "name": "string",
  • "active": true,
  • "description": "string",
  • "roles": [
    • {
      • "type": "string",
      • "value": "string"
      }
    ]
}

Response samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "id": "string",
  • "meta": {
    • "resourceType": "string",
    • "created": "string",
    • "lastModified": "string"
    },
  • "name": "string",
  • "active": true,
  • "description": "string",
  • "apiKey": "string",
  • "groups": [
    • {
      • "type": "string",
      • "display": "string",
      • "value": "string"
      }
    ],
  • "roles": [
    • {
      • "type": "string",
      • "value": "string"
      }
    ]
}

Service Accounts - Get a service account

Implements Retrieving a Known Resource from the SCIM protocol specification for Tecton service accounts.

Authorizations:
(Bearer/AdminTecton-key/Admin)
path Parameters
id
required
string

A unique identifier for the Service Account as defined by Tecton.

Responses

Response samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "id": "string",
  • "meta": {
    • "resourceType": "string",
    • "created": "string",
    • "lastModified": "string"
    },
  • "name": "string",
  • "active": true,
  • "description": "string",
  • "groups": [
    • {
      • "type": "string",
      • "display": "string",
      • "value": "string"
      }
    ],
  • "roles": [
    • {
      • "type": "string",
      • "value": "string"
      }
    ]
}

Service Accounts - Delete a service account

See: Deleting Resources.

Authorizations:
(Bearer/AdminTecton-key/Admin)
path Parameters
id
required
string

A unique identifier for the Service Account as defined by Tecton.

Responses

Response samples

Content type
application/json
{ }

Service Accounts - Replace a service account

Update a Service Account (i.e. update their name, description, active and/or roles). See: Replacing with PUT.

Authorizations:
(Bearer/AdminTecton-key/Admin)
path Parameters
id
required
string

A unique identifier the Service Account as defined by Tecton.

Request Body schema: application/json
required
schemas
Array of strings

Expected to be ["urn:ietf:params:scim:schemas:tecton:1.0:ServiceAccount"].

object (scimResourceMeta)

A complex attribute containing resource metadata. This is optional on requests. See the specification.

name
string

The Service Account's name. The name is unique. It is editable.

active
boolean

Whether the Service Account is active or not. Setting a Service Account as inactive will preserve their group memberships and role assignments. Inactive Service Accounts can not call Tecton APIs. Inactive Service Accounts may be reactivated by setting active to true.

description
string

Text to describe the Service Account, typically what the Service Account is used for.

Array of objects (scimAttributeRole)

The roles directly assigned to the service account. This property is editable.

Responses

Request samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "meta": {
    • "resourceType": "string",
    • "created": "string",
    • "lastModified": "string"
    },
  • "name": "string",
  • "active": true,
  • "description": "string",
  • "roles": [
    • {
      • "type": "string",
      • "value": "string"
      }
    ]
}

Response samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "id": "string",
  • "meta": {
    • "resourceType": "string",
    • "created": "string",
    • "lastModified": "string"
    },
  • "name": "string",
  • "active": true,
  • "description": "string",
  • "groups": [
    • {
      • "type": "string",
      • "display": "string",
      • "value": "string"
      }
    ],
  • "roles": [
    • {
      • "type": "string",
      • "value": "string"
      }
    ]
}

Users - Get all users

Implements Query Resources for users from the SCIM protocol specification. Note that role assignments and memberships are not returned for each user (call "Get a user" instead).

Authorizations:
(Bearer/AdminTecton-key/Admin)
query Parameters
filter
string

See filtering logic in SCIM specification. Tecton only supports "equality" filtering at this time, e.g. username eq email@example.com.

startIndex
integer <int64>

This represents the 1-based index of the first query result. A value less than 1 SHALL be interpreted as 1. Default is 1. See here for information on pagination.

count
integer <int64>

Specifies the desired maximum number of query results per page. Must be non-negative: negative numbers will be treated as 0. No default value.

sortBy
string

Sorting is optional. See here for more information on this field.

sortOrder
string

Allowed values are ascending and descending. Defaults to ascending.

Responses

Response samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "startIndex": 0,
  • "itemsPerPage": 0,
  • "totalResults": 0,
  • "Resources": [
    • {
      • "schemas": [
        • "string"
        ],
      • "id": "string",
      • "meta": {
        • "resourceType": "string",
        • "created": "string",
        • "lastModified": "string"
        },
      • "userName": "string",
      • "name": {
        • "familyName": "string",
        • "givenName": "string"
        },
      • "active": true,
      • "emails": [
        • {
          • "type": "string",
          • "primary": true,
          • "value": "string"
          }
        ]
      }
    ]
}

Users - Create a user

Create a new user. Note that the userName must be an email and must be unique. Group memberships must be set after the user is created. See: Creating Resources.

Authorizations:
(Bearer/AdminTecton-key/Admin)
Request Body schema: application/json
required
schemas
Array of strings

Expected to be ["urn:ietf:params:scim:schemas:core:2.0:User"].

object (scimResourceMeta)

A complex attribute containing resource metadata. This is optional on requests. See the specification.

userName
string

A service provider's unique identifier for the user, typically used by the user to directly authenticate to the service provider. This attribute is required and is case-sensitive. In Tecton, this must be an email.

object (scimUserName)

The components of the user's name. See the specification.

active
boolean

A Boolean value indicating the user's administrative status. True means the user is able to log in. Tecton does not have a concept of inactive users; instead, they will be deleted.

Array of objects (scimAttributeEmail)

The user's email. Only a single primary email is supported and others will be ignored.

Array of objects (scimAttributeRole)

The roles directly assigned to the user.

Responses

Request samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "meta": {
    • "resourceType": "string",
    • "created": "string",
    • "lastModified": "string"
    },
  • "userName": "string",
  • "name": {
    • "familyName": "string",
    • "givenName": "string"
    },
  • "active": true,
  • "emails": [
    • {
      • "type": "string",
      • "primary": true,
      • "value": "string"
      }
    ],
  • "roles": [
    • {
      • "type": "string",
      • "value": "string"
      }
    ]
}

Response samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "id": "string",
  • "meta": {
    • "resourceType": "string",
    • "created": "string",
    • "lastModified": "string"
    },
  • "userName": "string",
  • "name": {
    • "familyName": "string",
    • "givenName": "string"
    },
  • "active": true,
  • "emails": [
    • {
      • "type": "string",
      • "primary": true,
      • "value": "string"
      }
    ],
  • "groups": [
    • {
      • "type": "string",
      • "display": "string",
      • "value": "string"
      }
    ],
  • "roles": [
    • {
      • "type": "string",
      • "value": "string"
      }
    ]
}

Users - Get a user

Implements Retrieving a Known Resource from the SCIM protocol specification.

Authorizations:
(Bearer/AdminTecton-key/Admin)
path Parameters
id
required
string

A unique identifier for the User as defined by Tecton.

Responses

Response samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "id": "string",
  • "meta": {
    • "resourceType": "string",
    • "created": "string",
    • "lastModified": "string"
    },
  • "userName": "string",
  • "name": {
    • "familyName": "string",
    • "givenName": "string"
    },
  • "active": true,
  • "emails": [
    • {
      • "type": "string",
      • "primary": true,
      • "value": "string"
      }
    ],
  • "groups": [
    • {
      • "type": "string",
      • "display": "string",
      • "value": "string"
      }
    ],
  • "roles": [
    • {
      • "type": "string",
      • "value": "string"
      }
    ]
}

Users - Delete a user

See: Deleting Resources.

Authorizations:
(Bearer/AdminTecton-key/Admin)
path Parameters
id
required
string

A unique identifier for the User as defined by Tecton.

Responses

Response samples

Content type
application/json
{ }

Users - Replace a user

Update a user (i.e. update their roles). Note that setting a user to active: false will delete the user from Tecton and all of their role assignments and group memberships will be removed. See: Replacing with PUT.

Authorizations:
(Bearer/AdminTecton-key/Admin)
path Parameters
id
required
string

A unique identifier for the User as defined by Tecton.

Request Body schema: application/json
required
schemas
Array of strings

Expected to be ["urn:ietf:params:scim:schemas:core:2.0:User"].

object (scimResourceMeta)

A complex attribute containing resource metadata. This is optional on requests. See the specification.

userName
string

A service provider's unique identifier for the user, typically used by the user to directly authenticate to the service provider. This attribute is required and is case-sensitive. In Tecton, this must be an email.

object (scimUserName)

The components of the user's name. See the specification.

active
boolean

A Boolean value indicating the user's administrative status. True means the user is able to log in. Tecton does not have a concept of inactive users; instead, they will be deleted.

Array of objects (scimAttributeEmail)

The user's email. Only a single primary email is supported and others will be ignored.

Array of objects (scimAttributeRole)

The roles directly assigned to the user.

Responses

Request samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "meta": {
    • "resourceType": "string",
    • "created": "string",
    • "lastModified": "string"
    },
  • "userName": "string",
  • "name": {
    • "familyName": "string",
    • "givenName": "string"
    },
  • "active": true,
  • "emails": [
    • {
      • "type": "string",
      • "primary": true,
      • "value": "string"
      }
    ],
  • "roles": [
    • {
      • "type": "string",
      • "value": "string"
      }
    ]
}

Response samples

Content type
application/json
{
  • "schemas": [
    • "string"
    ],
  • "id": "string",
  • "meta": {
    • "resourceType": "string",
    • "created": "string",
    • "lastModified": "string"
    },
  • "userName": "string",
  • "name": {
    • "familyName": "string",
    • "givenName": "string"
    },
  • "active": true,
  • "emails": [
    • {
      • "type": "string",
      • "primary": true,
      • "value": "string"
      }
    ],
  • "groups": [
    • {
      • "type": "string",
      • "display": "string",
      • "value": "string"
      }
    ],
  • "roles": [
    • {
      • "type": "string",
      • "value": "string"
      }
    ]
}

Secrets Service

Tecton Secrets provides a way to store and retrieve secrets for use in your feature pipelines and data sources. This API allows you to securely store and delete secrets in Tecton, as well as create, list, and delete the scopes these secrets belong to.

💡 Private Preview

Note that this API is currently in private preview. To request access, please contact your Tecton representative.

Assign role(s) on secret scope(s)

Make one or more role assignments to grant principals roles on Secret Scopes. Grant a user, service account, or group a role to allow them to read or update secrets in the scope. Grant a workspace a role to apply objects and materialize features using secrets in the scope.

Authorizations:
(BearerTecton-key)
Request Body schema: application/json
required
Array of objects (authAssignment)
Array
resourceType
string (authResourceType)
Value: "RESOURCE_TYPE_SECRET_SCOPE"

Enum values should start with RESOURCE_TYPE_ and use "_" in place of spaces. Authorization interceptor converts these values into strings that may be presented to users in error messages.

resourceId
string

Secret scope name

role
string

One of "read_scope_role", "write_scope_role", or "manage_scope_role"

principalType
string (authPrincipalType)
Enum: "PRINCIPAL_TYPE_USER" "PRINCIPAL_TYPE_SERVICE_ACCOUNT" "PRINCIPAL_TYPE_GROUP" "PRINCIPAL_TYPE_WORKSPACE"
principalId
string

User ID, Service Account ID, Group ID, or Workspace name

Responses

Request samples

Content type
application/json
{
  • "assignments": [
    • {
      • "principal_type": "PRINCIPAL_TYPE_WORKSPACE",
      • "principal_id": "my-workspace",
      • "resource_type": "RESOURCE_TYPE_SECRET_SCOPE",
      • "resource_id": "my-secret-scope",
      • "role": "read_scope_role"
      }
    ]
}

Response samples

Content type
application/json
{ }

View principals with access to a secret scope

View all principals and their role assignments on a particular secret scope

Authorizations:
(BearerTecton-key)
Request Body schema: application/json
required
resourceType
string (authResourceType)
Value: "RESOURCE_TYPE_SECRET_SCOPE"

Enum values should start with RESOURCE_TYPE_ and use "_" in place of spaces. Authorization interceptor converts these values into strings that may be presented to users in error messages.

resourceId
string

Secret scope name

roles
Array of strings (optional)

Optional list containing a subset of "read_scope_role", "write_scope_role", or "manage_scope_role"

principalTypes
Array of strings (optional)
Items Enum: "PRINCIPAL_TYPE_USER" "PRINCIPAL_TYPE_SERVICE_ACCOUNT" "PRINCIPAL_TYPE_GROUP" "PRINCIPAL_TYPE_WORKSPACE"

Responses

Request samples

Content type
application/json
{
  • "resource_type": "RESOURCE_TYPE_SECRET_SCOPE",
  • "resource_id": "my-secret-scope",
  • "principal_types": [
    • "PRINCIPAL_TYPE_SERVICE_ACCOUNT"
    ]
}

Response samples

Content type
application/json
{
  • "assignments": [
    • {
      • "principal": {
        • "service_account": {
          • "id": "98be6e950d8c4b14aeb32f48b20a9245",
          • "name": "my-service-account",
          • "description": "desc",
          • "is_active": true,
          • "creator": {
            • "principal_type": "PRINCIPAL_TYPE_USER",
            • "id": "user-id"
            }
          }
        },
      • "role_assignments": [
        • {
          • "resource_type": "RESOURCE_TYPE_SECRET_SCOPE",
          • "resource_id": "my-secret-scope",
          • "roles_granted": [
            • {
              • "role": "read_scope_role",
              • "role_assignment_sources": [
                • {
                  • "assignment_type": "ROLE_ASSIGNMENT_TYPE_DIRECT"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
}

View a principal's role(s) on secret scope(s)

View roles granted to a particular User, Service Account, Principal Group, or Workspace on Secret Scopes.

Authorizations:
(BearerTecton-key)
Request Body schema: application/json
required
principalType
string (authPrincipalType)
Enum: "PRINCIPAL_TYPE_USER" "PRINCIPAL_TYPE_SERVICE_ACCOUNT" "PRINCIPAL_TYPE_GROUP" "PRINCIPAL_TYPE_WORKSPACE"
principalId
string

User ID, Service Account ID, Group ID, or Workspace name

resourceType
string (authResourceType)
Value: "RESOURCE_TYPE_SECRET_SCOPE"

Enum values should start with RESOURCE_TYPE_ and use "_" in place of spaces. Authorization interceptor converts these values into strings that may be presented to users in error messages.

resourceIds
Array of strings (optional)

Optional list of secret scope names

roles
Array of strings (optional)

Optional list containing a subset of "read_scope_role", "write_scope_role", or "manage_scope_role"

Responses

Request samples

Content type
application/json
{
  • "principal_type": "PRINCIPAL_TYPE_SERVICE_ACCOUNT",
  • "principal_id": "service-account-id",
  • "resource_type": "RESOURCE_TYPE_SECRET_SCOPE"
}

Response samples

Content type
application/json
{
  • "assignments": [
    • {
      • "resource_type": "RESOURCE_TYPE_SECRET_SCOPE",
      • "resource_id": "my-secret-scope",
      • "roles_granted": [
        • {
          • "role": "write_scope_role",
          • "role_assignment_sources": [
            • {
              • "assignment_type": "ROLE_ASSIGNMENT_TYPE_DIRECT"
              }
            ]
          }
        ]
      }
    ]
}

Unassign role(s) on secret scope(s)

Remove one or more role assignments to revoke principals' roles on Secret Scopes

Authorizations:
(BearerTecton-key)
Request Body schema: application/json
required
Array of objects (authAssignment)
Array
resourceType
string (authResourceType)
Value: "RESOURCE_TYPE_SECRET_SCOPE"

Enum values should start with RESOURCE_TYPE_ and use "_" in place of spaces. Authorization interceptor converts these values into strings that may be presented to users in error messages.

resourceId
string

Secret scope name

role
string

One of "read_scope_role", "write_scope_role", or "manage_scope_role"

principalType
string (authPrincipalType)
Enum: "PRINCIPAL_TYPE_USER" "PRINCIPAL_TYPE_SERVICE_ACCOUNT" "PRINCIPAL_TYPE_GROUP" "PRINCIPAL_TYPE_WORKSPACE"
principalId
string

User ID, Service Account ID, Group ID, or Workspace name

Responses

Request samples

Content type
application/json
{
  • "assignments": [
    • {
      • "principal_type": "PRINCIPAL_TYPE_WORKSPACE",
      • "principal_id": "my-workspace",
      • "resource_type": "RESOURCE_TYPE_SECRET_SCOPE",
      • "resource_id": "my-secret-scope",
      • "role": "read_scope_role"
      }
    ]
}

Response samples

Content type
application/json
{ }

List all secret scopes

Returns a list of all secret scopes available in the cluster.

Authorizations:
(BearerTecton-key)

Responses

Response samples

Content type
application/json
{
  • "scopes": [
    • {
      • "name": "my-secret-scope"
      }
    ]
}

Delete a secret scope

Deletes a secret scope. Note that any secrets in the scope must first be deleted before this operation can be performed or this operation will fail.

Authorizations:
(BearerTecton-key)
path Parameters
scope
required
string

Responses

Response samples

Content type
application/json
{ }

Create a secret scope

Creates a new secret scope. The creator will be granted manager (full) access to the scope. This operation will fail if the scope already exists.

Authorizations:
(BearerTecton-key)
path Parameters
scope
required
string

Responses

Response samples

Content type
application/json
{ }

List secrets in a scope

Return a list of all secrets in a secret scope.

Authorizations:
(BearerTecton-key)
path Parameters
scope
required
string

Responses

Response samples

Content type
application/json
{
  • "keys": [
    • {
      • "name": "sample-key"
      }
    ]
}

Get a secret value

Gets the value of a secret given a secret scope and key.

Authorizations:
(BearerTecton-key)
path Parameters
scope
required
string
key
required
string

Responses

Response samples

Content type
application/json
{
  • "value": "shhh"
}

Delete a secret

Deletes a secret key/value pair within a secret scope. This operation will immediately delete the secret key/value pair with no grace period.

Authorizations:
(BearerTecton-key)
path Parameters
scope
required
string
key
required
string

Responses

Response samples

Content type
application/json
{ }

Put a secret value

Puts a secret value in a secret scope with a given key and value. Note that this operation is idempotent: it will create the secret key/value pair if the key does not exist, and it will overwrite an existing value if the key does exist. It will not return an error if the key and value are already present.

Therefore, this operation can be called multiple times without error.

Authorizations:
(BearerTecton-key)
path Parameters
scope
required
string
key
required
string
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "shhh"
}

Response samples

Content type
application/json
{ }

Server Group Service

Tecton's Server Group Service provides APIs for managing compute infrastructure for streaming and real-time workloads. Server Groups are managed compute clusters that execute user-defined transformations and handle feature processing.

Server Group Types

  • Transform Server Groups: Execute user defined transformations for streaming and realtime feature computations.
  • Ingest Server Groups: Handle streaming data ingestion for Tecton's Stream Ingest API.

Key Features

  • Flexible Scaling: Support both autoscaling (dynamic node adjustment) and provisioned (fixed capacity) modes
  • Isolation: Server Groups within the same workspace are isolated to ensure independent and performant operations
  • Configuration Management: Comprehensive configuration options including node types, environments, and custom variables

List Ingest Server Groups

Retrieves all Ingest Server Groups within the specified workspace, including their current configuration, status, and metadata.

Authorizations:
(BearerTecton-key)
query Parameters
workspace
string

The name of the workspace to list Ingest Server Groups in. If no workspace is provided, list all Ingest Server Groups across all workspaces the caller has permissions to view.

Responses

Response samples

Content type
application/json
{
  • "ingestServerGroups": [
    • {
      • "id": "f8c3de3d1fea4d7c8b5a6d4b2e1f3a7c",
      • "name": "stream-ingest",
      • "workspace": "prod-workspace",
      • "status": "READY",
      • "autoscalingConfig": {
        • "minNodes": 2,
        • "maxNodes": 20
        },
      • "nodeType": "m5.xlarge"
      },
    • {
      • "id": "e4b8c2a6d1f9e5c7b3a8d2f6e9c4a7b1",
      • "name": "event-processing",
      • "workspace": "prod-workspace",
      • "status": "PENDING",
      • "provisionedConfig": {
        • "desiredNodes": 5
        },
      • "nodeType": "m5.2xlarge",
      • "pendingConfig": {
        • "provisionedConfig": {
          • "desiredNodes": 5
          },
        • "nodeType": "m5.2xlarge"
        }
      }
    ]
}

Create Ingest Server Group

Creates a new Ingest Server Group for handling streaming data ingestion via Tecton's Stream Ingest API. Ingest Server Groups support both provisioned and autoscaling modes and are isolated from each other to ensure independent and performant stream processing operations.

Authorizations:
(BearerTecton-key)
Request Body schema: application/json
required
workspace
string

The name of the workspace to create the Ingest Server Group in. Must be a live workspace.

name
string

The name of the Ingest Server Group. Must be unique within the workspace. Naming requirements: Start with a letter. Use only letters, digits, hyphens, or underscores. Maximum 64 characters. Note: Combined workspace and Server Group name length cannot exceed 64 characters.

object (ResourceMetadata)

Metadata for Server Groups containing descriptive information and organizational labels. This metadata helps with Server Group organization and ownership tracking across environments.

object (AutoscalingConfig)

Autoscaling configuration for Server Groups with dynamic scaling. Specifies the node count range that Tecton can scale between based on workload.

object (ProvisionedScalingConfig)

Provisioned scaling configuration for Server Groups with fixed capacity. Specifies the constant node count for the Server Group.

nodeType
string

The instance type for Ingest Server Group nodes. Optional. Defaults to m6a.2xlarge if not specified. Must be a valid instance type (e.g., m5.large, c5.xlarge).

Responses

Request samples

Content type
application/json
{
  • "workspace": "prod-workspace",
  • "name": "stream-ingest",
  • "autoscalingConfig": {
    • "minNodes": 2,
    • "maxNodes": 20
    },
  • "nodeType": "m5.xlarge",
  • "metadata": {
    • "description": "Production stream ingestion server group",
    • "tags": {
      • "team": "data-platform",
      • "environment": "prod"
      },
    • "owner": "data-team@company.com"
    }
}

Response samples

Content type
application/json
{
  • "workspace": "prod-workspace",
  • "name": "stream-ingest",
  • "id": "f8c3de3d1fea4d7c8b5a6d4b2e1f3a7c",
  • "metadata": {
    • "description": "Production stream ingestion server group",
    • "tags": {
      • "team": "data-platform",
      • "environment": "prod"
      },
    • "owner": "data-team@company.com"
    },
  • "status": "PENDING",
  • "pending_config": {
    • "autoscaling_config": {
      • "min_nodes": 2,
      • "max_nodes": 20
      },
    • "node_type": "m5.xlarge"
    }
}

Get Ingest Server Group

Retrieves detailed information about a specific Ingest Server Group, including its current configuration, status, scaling settings, and metadata.

Authorizations:
(BearerTecton-key)
path Parameters
id
required
string

The ID of the Ingest Server Group to retrieve.

Responses

Response samples

Content type
application/json
{
  • "id": "f8c3de3d1fea4d7c8b5a6d4b2e1f3a7c",
  • "name": "stream-ingest",
  • "workspace": "prod-workspace",
  • "status": "READY",
  • "autoscalingConfig": {
    • "minNodes": 2,
    • "maxNodes": 20
    },
  • "nodeType": "m5.xlarge",
  • "createdAt": "2024-01-15T10:30:00Z",
  • "updatedAt": "2024-01-15T10:30:00Z",
  • "metadata": {
    • "description": "Production stream ingestion",
    • "tags": {
      • "team": "data-platform"
      }
    }
}

Delete Ingest Server Group

Permanently removes an Ingest Server Group and deprovisions its underlying infrastructure. Ensure the Ingest Server Group is not being used by any Stream Sources before deletion.

Authorizations:
(BearerTecton-key)
path Parameters
id
required
string

The ID of the Ingest Server Group to delete.

Responses

Response samples

Content type
application/json
{ }

Update Ingest Server Group

Updates the configuration of an existing Ingest Server Group. This includes scaling settings, node types, and metadata. Monitor the status via GET API to track update progress.

Authorizations:
(BearerTecton-key)
path Parameters
id
required
string

The ID of the Ingest Server Group to update.

Request Body schema: application/json
required
object (ResourceMetadata)

Metadata for Server Groups containing descriptive information and organizational labels. This metadata helps with Server Group organization and ownership tracking across environments.

object (AutoscalingConfig)

Autoscaling configuration for Server Groups with dynamic scaling. Specifies the node count range that Tecton can scale between based on workload.

object (ProvisionedScalingConfig)

Provisioned scaling configuration for Server Groups with fixed capacity. Specifies the constant node count for the Server Group.

nodeType
string

The instance type for Ingest Server Group nodes. Optional. Defaults to m6a.2xlarge if not specified. Must be a valid instance type (e.g., m5.large, c5.xlarge). Note: Node type updates may take several minutes to complete.

Responses

Request samples

Content type
application/json
{
  • "id": "f8c3de3d1fea4d7c8b5a6d4b2e1f3a7c",
  • "provisionedConfig": {
    • "desiredNodes": 5
    },
  • "nodeType": "m5.2xlarge",
  • "metadata": {
    • "description": "Updated stream ingestion server group",
    • "tags": {
      • "environment": "prod",
      • "team": "data-platform"
      }
    }
}

Response samples

Content type
application/json
{
  • "id": "f8c3de3d1fea4d7c8b5a6d4b2e1f3a7c",
  • "name": "stream-ingest",
  • "workspace": "prod-workspace",
  • "status": "READY",
  • "autoscalingConfig": {
    • "minNodes": 2,
    • "maxNodes": 20
    },
  • "nodeType": "m5.xlarge",
  • "updatedAt": "2024-01-15T14:30:00Z",
  • "pendingConfig": {
    • "provisionedConfig": {
      • "desiredNodes": 5
      },
    • "nodeType": "m5.2xlarge"
    }
}

List Transform Server Groups

Authorizations:
(BearerTecton-key)
query Parameters
workspace
string

The name of the workspace to list Transform Server Groups in. If no workspace is provided, list all Transform Server Groups across all workspaces the caller has permissions to view.

Responses

Response samples

Content type
application/json
{
  • "transformServerGroups": [
    • {
      • "id": "3d141030af607aa584af9f59881e369b",
      • "name": "ml-transforms",
      • "workspace": "prod-workspace",
      • "status": "READY",
      • "autoscalingConfig": {
        • "minNodes": 1,
        • "maxNodes": 10
        },
      • "nodeType": "m5.large",
      • "environment": "tecton-core:1.2"
      },
    • {
      • "id": "f8c3de3d1fea4d7c8b5a6d4b2e1f3a7c",
      • "name": "data-processing",
      • "workspace": "prod-workspace",
      • "status": "PENDING",
      • "provisionedConfig": {
        • "desiredNodes": 3
        },
      • "nodeType": "m5.xlarge",
      • "environment": "tecton-core:1.2",
      • "pendingConfig": {
        • "provisionedConfig": {
          • "desiredNodes": 3
          },
        • "nodeType": "m5.xlarge",
        • "environment": "tecton-core:1.2"
        }
      }
    ]
}

Create Transform Server Group

Creates a new Transform Server Group for executing real-time transformations. Transform Server Groups support both provisioned and autoscaling modes and are isolated from each other to ensure independent and performant operations.

Authorizations:
(BearerTecton-key)
Request Body schema: application/json
required
workspace
string

The name of the workspace to create the Transform Server Group in. Must be a live workspace.

name
string

The name of the Transform Server Group. Must be unique within the workspace. Naming requirements: Start with a letter. Use only letters, digits, hyphens, or underscores. Maximum 64 characters. Note: Combined workspace and Server Group name length cannot exceed 64 characters.

object (ResourceMetadata)

Metadata for Server Groups containing descriptive information and organizational labels. This metadata helps with Server Group organization and ownership tracking across environments.

object (AutoscalingConfig)

Autoscaling configuration for Server Groups with dynamic scaling. Specifies the node count range that Tecton can scale between based on workload.

object (ProvisionedScalingConfig)

Provisioned scaling configuration for Server Groups with fixed capacity. Specifies the constant node count for the Server Group.

nodeType
string

The instance type for Transform Server Group nodes. Optional. Defaults to m6a.2xlarge if not specified. Must be a valid instance type (e.g., m5.large, c5.xlarge).

environment
string

The Tecton Environment to use for executing transformations in this Transform Server Group. Required. Specify a Tecton-managed core environment or use a custom environment. Must be READY and include the tecton-runtime package. See https://docs.tecton.ai/docs/defining-features/feature-views/realtime-feature-view/realtime-feature-view-environments for creating custom environments.

environmentVariables
object

Key-value pairs of environment variables for the Transform Server Group. These variables will be available in the runtime environment where user transformations are executed.

Responses

Request samples

Content type
application/json
{
  • "workspace": "prod-workspace",
  • "name": "ml-transforms",
  • "autoscalingConfig": {
    • "minNodes": 1,
    • "maxNodes": 10
    },
  • "nodeType": "m5.large",
  • "environment": "tecton-core:1.2",
  • "environmentVariables": {
    • "MY_ENV_KEY": "my_env_value",
    • "ANOTHER_KEY": "another_value"
    }
}

Response samples

Content type
application/json
{
  • "workspace": "server-group-test",
  • "name": "second-test-test",
  • "id": "00c6726794fe4655a218187f76a030b4",
  • "metadata": {
    • "description": "This is a test TSG",
    • "tags": {
      • "test-key": "test-value"
      },
    • "owner": "pooja@tecton.ai"
    },
  • "status": "PENDING",
  • "pending_config": {
    • "autoscaling_config": {
      • "min_nodes": 1,
      • "max_nodes": 5
      },
    • "environment": "server-group-test",
    • "environment_variables": {
      • "MY_ENV_VARIABLE": "MY_VALUE"
      },
    • "node_type": "m6a.xlarge"
    }
}

Get Transform Server Group

Authorizations:
(BearerTecton-key)
path Parameters
id
required
string

The ID of the Transform Server Group to retrieve.

Responses

Response samples

Content type
application/json
{
  • "id": "3d141030af607aa584af9f59881e369b",
  • "name": "ml-transforms",
  • "workspace": "prod-workspace",
  • "status": "READY",
  • "autoscalingConfig": {
    • "minNodes": 1,
    • "maxNodes": 10
    },
  • "nodeType": "m5.large",
  • "environment": "tecton-core:1.2",
  • "createdAt": "2024-01-15T10:30:00Z",
  • "updatedAt": "2024-01-15T10:30:00Z",
  • "metadata": {
    • "description": "Production ML transforms",
    • "tags": {
      • "team": "ml-platform"
      }
    }
}

Delete Transform Server Group

Authorizations:
(BearerTecton-key)
path Parameters
id
required
string

The ID of the Transform Server Group to delete.

Responses

Response samples

Content type
application/json
{ }

Update Transform Server Group

Updates the configuration of an existing Transform Server Group. This includes scaling settings, node types, environment variables, and metadata. Monitor the status via GET API to track update progress.

Authorizations:
(BearerTecton-key)
path Parameters
id
required
string

The ID of the Transform Server Group to update.

Request Body schema: application/json
required
object (ResourceMetadata)

Metadata for Server Groups containing descriptive information and organizational labels. This metadata helps with Server Group organization and ownership tracking across environments.

object (AutoscalingConfig)

Autoscaling configuration for Server Groups with dynamic scaling. Specifies the node count range that Tecton can scale between based on workload.

object (ProvisionedScalingConfig)

Provisioned scaling configuration for Server Groups with fixed capacity. Specifies the constant node count for the Server Group.

nodeType
string

The instance type for Transform Server Group nodes. Optional. Defaults to m6a.2xlarge if not specified. Must be a valid instance type (e.g., m5.large, c5.xlarge). Note: Node type updates may take several minutes to complete.

environment
string

The Tecton Environment to use for executing transformations in this Transform Server Group. Required. Specify a Tecton-managed core environment or use a custom environment. Must be READY and include the tecton-runtime package. See https://docs.tecton.ai/docs/defining-features/feature-views/realtime-feature-view/realtime-feature-view-environments for creating custom environments. Note: In-place environment updates should be done with caution, as any misconfiguration could impact a live Transform Server Group. To avoid disruptions, we recommend creating a new Transform Server Group with the desired environment instead.

environmentVariables
object

Key-value pairs of environment variables for the Transform Server Group. These variables will be available in the runtime environment where user transformations are executed. Note: For Update operations, providing environment_variables will completely replace all existing environment variables (not merge with existing variables).

Responses

Request samples

Content type
application/json
{
  • "id": "3d141030af607aa584af9f59881e369b",
  • "autoscalingConfig": {
    • "minNodes": 2,
    • "maxNodes": 15
    },
  • "nodeType": "m5.xlarge",
  • "environment": "tecton-core:1.2",
  • "environmentVariables": {
    • "MY_ENV_KEY": "my_env_value",
    • "ANOTHER_KEY": "another_value"
    },
  • "metadata": {
    • "description": "Updated ML transforms server group",
    • "tags": {
      • "environment": "prod",
      • "team": "ml-platform"
      }
    }
}

Response samples

Content type
application/json
{
  • "id": "3d141030af607aa584af9f59881e369b",
  • "name": "ml-transforms",
  • "workspace": "prod-workspace",
  • "status": "READY",
  • "autoscalingConfig": {
    • "minNodes": 1,
    • "maxNodes": 10
    },
  • "nodeType": "m5.large",
  • "environment": "tecton-core:1.2",
  • "updatedAt": "2024-01-15T14:30:00Z",
  • "pendingConfig": {
    • "autoscalingConfig": {
      • "minNodes": 2,
      • "maxNodes": 15
      },
    • "nodeType": "m5.xlarge",
    • "environment": "tecton-core:1.2",
    • "environmentVariables": {
      • "MY_ENV_KEY": "my_env_value",
      • "ANOTHER_KEY": "another_value"
      }
    }
}

Service Accounts Service

Tecton Service Accounts can authenticate requests to Tecton APIs using either API key credentials or OAuth 2.0 client credentials with access token. Use these Service Account API endpoints to manage your Tecton Service Accounts. For full usage instructions, see this page.

⚠️ Public Preview

Note that OAuth Service accounts is currently in Public Preview. To learn more, please contact your Tecton representative.

Create a service account

Create a new Service Account.

Service Accounts can be created using one of two possible authentication methods:

  • The API Key option provides a single randomly generated key (returned in the 'apiKey' field).
  • The Client Credentials option provides an OAuth client with its client id (returned in the 'id' field) and client secret (returned in the 'clientSecret' field).

Note that the Service Account name must be unique.

Authorizations:
(BearerTecton-key)
Request Body schema: application/json
required
name
string

The Service Account's display name. The name must be unique. It is editable.

description
string

Text to describe the Service Account, typically what the Service Account is used for. It is editable.

credentialsType
string (dataServiceAccountCredentialsType)
Enum: "SERVICE_ACCOUNT_CREDENTIALS_TYPE_API_KEY" "SERVICE_ACCOUNT_CREDENTIALS_TYPE_OAUTH_CLIENT_CREDENTIALS"

Authentication method assigned to a Service Account.

  • SERVICE_ACCOUNT_CREDENTIALS_TYPE_API_KEY: API Key authentication method.
  • SERVICE_ACCOUNT_CREDENTIALS_TYPE_OAUTH_CLIENT_CREDENTIALS: OAuth Client Credentials authentication method.

Responses

Request samples

Content type
application/json
{
  • "name": "my-service-account",
  • "description": "description of my-service-account",
  • "credentialsType": "SERVICE_ACCOUNT_CREDENTIALS_TYPE_OAUTH_CLIENT_CREDENTIALS"
}

Response samples

Content type
application/json
{
  • "id": "0oa1a45o42rZDl3g4358",
  • "name": "my-service-account",
  • "description": "description of my-service-account",
  • "isActive": true,
  • "createdAt": "2024-12-05T16:40:23.674137Z",
  • "credentialsType": "SERVICE_ACCOUNT_CREDENTIALS_TYPE_OAUTH_CLIENT_CREDENTIALS",
  • "clientSecret": "XDuLEgl_uxbhuQMowe8VrD_WC15en_659NQ7tThj0n7rb3aSrpKcp3saxF0pYv_w"
}

Get multiple service accounts

Retrieve multiple Service Accounts filtering by name, description or id.

Authorizations:
(BearerTecton-key)
Request Body schema: application/json
required
search
string

Search string filter that partially matches the name, description, or id of Service Accounts. Note that matches are case-insensitive.

ids
Array of strings

List of Service Accounts ids to be included in the search. If the list is null then all Service Accounts are included.

Responses

Request samples

Content type
application/json
{
  • "search": "my",
  • "ids": [
    • "0oa1a45o42rZDl3g4358",
    • "d3a38a4be4bc45a58c8223ae57b0d267"
    ]
}

Response samples

Content type
application/json
{
  • "serviceAccounts": [
    • {
      • "id": "0oa1a45o42rZDl3g4358",
      • "name": "my-service-account",
      • "description": "description of my-service-account",
      • "isActive": true,
      • "createdBy": {
        • "user": {
          • "oktaId": "00u18938zqdN98Gzq358",
          • "firstName": "FirstName",
          • "lastName": "LastName",
          • "loginEmail": "firstname.lastname@tecton.ai"
          }
        },
      • "createdAt": "2024-12-05T18:46:50.927807Z",
      • "credentialsType": "SERVICE_ACCOUNT_CREDENTIALS_TYPE_OAUTH_CLIENT_CREDENTIALS"
      },
    • {
      • "id": "d3a38a4be4bc45a58c8223ae57b0d267",
      • "name": "my-service-account-api-key",
      • "description": "description of my-service-account-api-key",
      • "isActive": true,
      • "createdBy": {
        • "user": {
          • "oktaId": "00u18938zqdN98Gzq358",
          • "firstName": "FirstName",
          • "lastName": "LastName",
          • "loginEmail": "firstname.lastname@tecton.ai"
          }
        },
      • "createdAt": "2024-12-06T05:57:40.428939Z",
      • "credentialsType": "SERVICE_ACCOUNT_CREDENTIALS_TYPE_API_KEY"
      }
    ]
}

Delete a service account

Delete an existing Service Account. Note that Service Accounts must be deactivated before deletion.

Authorizations:
(BearerTecton-key)
path Parameters
id
required
string

Unique identifier of the Service Account as defined by Tecton.

Responses

Response samples

Content type
application/json
{ }

Update a service account

Update a Service Account (i.e. update their name, description, active status). Note that updating the active status of a Service Account triggers its activation or deactivation.

Authorizations:
(BearerTecton-key)
path Parameters
id
required
string

Unique identifier of the Service Account as defined by Tecton.

Request Body schema: application/json
required
name
string

The Service Account's display name. The name must be unique.

description
string

Text to describe the Service Account, typically what the Service Account is used for.

isActive
boolean

Whether the Service Account is to be activated or deactivated.

  • Setting the value to true will trigger the activation
  • Setting the value to false will trigger the deactivation

Setting a Service Account as inactive will preserve their group memberships and role assignments. Inactive Service Accounts can not call Tecton APIs. Inactive Service Accounts may be reactivated by setting active to true.

Responses

Request samples

Content type
application/json
{
  • "id": "0oa1a45o42rZDl3g4358",
  • "name": "updated-my-service-account",
  • "description": "updated description of my-service-account",
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "id": "0oa1a45o42rZDl3g4358",
  • "name": "updated-my-service-account",
  • "description": "updated description of my-service-account",
  • "isActive": true,
  • "createdAt": "2024-12-06T06:47:28.184810Z"
}

List all client secrets

Retrieve all the client secrets of a Service Account with OAuth credentials. Secret values cannot be retrieved, only masked values. Note that this endpoint can only be called for Service Accounts with OAuth credentials.

Authorizations:
(BearerTecton-key)
path Parameters
id
required
string

Service Account ID

Responses

Response samples

Content type
application/json
{
  • "clientSecrets": [
    • {
      • "secretId": "ocs1di9xhlvn2shQU358",
      • "createdAt": "2024-11-28T06:21:10.000Z",
      • "updatedAt": "2024-12-30T06:21:10.000Z",
      • "status": "ACTIVE",
      • "maskedSecret": "************hbDU"
      }
    ]
}

Create a client secret

Create a new client secret for a Service Account with OAuth credentials. Please save the secret value. It will never be displayed again. Note that this endpoint can only be called for Service Accounts with OAuth credentials.

Authorizations:
(BearerTecton-key)
path Parameters
id
required
string

Service Account ID

Request Body schema: application/json
required
object (ServiceAccountsServiceCreateServiceAccountSecretBody)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "secret": {
    • "secretId": "ocs1di9xhlvn2shQU358",
    • "createdAt": "2024-11-28T06:21:10.000Z",
    • "status": "ACTIVE",
    • "secret": "VKm812sgpyj-DordNyGbe8vTA4se_x1z4nDiXomBO1ByMOYVPH9C4JBJOLEFhbDU"
    }
}

Delete a client secret

Delete a single client secret of a Service Account with OAuth credentials. The client secret must be deactivated first before deletion. Note that this endpoint can only be called for Service Accounts with OAuth credentials.

Authorizations:
(BearerTecton-key)
path Parameters
serviceAccountId
required
string
secretId
required
string

Responses

Response samples

Content type
application/json
{ }

Activate a client secret

Activate a single client secret of a Service Account with OAuth credentials. It may take up to a minute for the activation to take effect. Note that this endpoint can only be called for Service Accounts with OAuth credentials.

Authorizations:
(BearerTecton-key)
path Parameters
serviceAccountId
required
string
secretId
required
string
Request Body schema: application/json
required
object (ServiceAccountsServiceActivateServiceAccountSecretBody)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "secret": {
    • "secretId": "ocs1di9xhlvn2shQU358",
    • "createdAt": "2024-11-28T06:21:10.000Z",
    • "updatedAt": "2024-12-30T06:21:10.000Z",
    • "status": "ACTIVE",
    • "maskedSecret": "************hbDU"
    }
}

Deactivate a client secret

Deactivate a single client secret of a Service Account with OAuth credentials. It may take up to a minute for the deactivation to take effect. Note that this endpoint can only be called for Service Accounts with OAuth credentials.

Authorizations:
(BearerTecton-key)
path Parameters
serviceAccountId
required
string
secretId
required
string
Request Body schema: application/json
required
object (ServiceAccountsServiceDeactivateServiceAccountSecretBody)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "secret": {
    • "secretId": "ocs1di9xhlvn2shQU358",
    • "createdAt": "2024-11-28T06:21:10.000Z",
    • "updatedAt": "2024-12-30T06:21:10.000Z",
    • "status": "ACTIVE",
    • "maskedSecret": "************hbDU"
    }
}

Workspaces

Administration of Workspaces. Workspaces are isolated environments for managing, configuring, and deploying Tecton feature repositories.

List all workspaces

Get all of the workspaces. All authenticated callers can call this endpoint.

Authorizations:
Tecton-key

Responses

Response samples

Content type
application/json
{
  • "workspaces": [
    • {
      • "name": "my-workspace",
      • "capabilities": {
        • "materializable": true,
        • "offline_store_subdirectory_enabled": true
        },
      • "compute_identities": [
        • {
          • "databricks_service_principal": {
            • "application_id": "2d5f7aca-a50c-42ba-bf7d-a30d6594f59f"
            }
          }
        ],
      • "created_at": "2025-03-20T20:19:37.597046750Z"
      }
    ]
}

Create a Workspace

Creates a new workspace. The creator will be granted the Owner role (full access) to the workspace. This operation will fail if there is already a workspace with the same name. Neither the name nor materializable properties can be edited so ensure they are set properly. If materializable is true, the caller must have the Admin role.

Authorizations:
Tecton-key
Request Body schema: application/json
required
workspaceName
string

The name (identifier) of the workspace.

object (dataWorkspaceCapabilities)
Array of objects (commonComputeIdentity)

[Databricks Only] An allow list of compute identities that may be used for materialization jobs in this workspace. The first element of this repeated list is the default identity for this workspace. This works since repeated fields are ordered. Application logic must ensure that the first element is the default identity.

Responses

Request samples

Content type
application/json
{
  • "workspace_name": "my-workspace",
  • "capabilities": {
    • "materializable": true,
    • "offline_store_subdirectory_enabled": true
    },
  • "compute_identities": [
    • {
      • "databricks_service_principal": {
        • "application_id": "2d5f7aca-a50c-42ba-bf7d-a30d6594f59f"
        }
      }
    ]
}

Response samples

Content type
application/json
{ }

Get a workspace

Get a single workspace by name. All authenticated callers can call this endpoint.

Authorizations:
Tecton-key
path Parameters
workspaceName
required
string

The name (identifier) of the workspace.

Responses

Response samples

Content type
application/json
{
  • "workspace": {
    • "name": "my-workspace",
    • "capabilities": {
      • "materializable": true,
      • "offline_store_subdirectory_enabled": true
      },
    • "compute_identities": [
      • {
        • "databricks_service_principal": {
          • "application_id": "2d5f7aca-a50c-42ba-bf7d-a30d6594f59f"
          }
        }
      ],
    • "created_at": "2025-03-20T20:19:37.597046750Z"
    }
}

Delete a workspace

Delete the workspace. This request requires the Owner role on the workspace.

Authorizations:
Tecton-key
path Parameters
workspace
required
string

The name (identifier) of the workspace.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Update a Workspace

Updates a workspace. Note that neither materializable nor the workspace's name are editable. This request requires having the Admin role.

Authorizations:
Tecton-key
path Parameters
workspace
required
string

The name (identifier) of the workspace.

Request Body schema: application/json
required
object (dataWorkspaceCapabilities)
Array of objects (commonComputeIdentity)

[Databricks Only] An allow list of compute identities that may be used for materialization jobs in this workspace. The first element of this repeated list is the default identity for this workspace. This works since repeated fields are ordered. Application logic must ensure that the first element is the default identity.

Responses

Request samples

Content type
application/json
{
  • "workspace": "my-workspace",
  • "capabilities": {
    • "offline_store_subdirectory_enabled": true
    },
  • "compute_identities": [
    • {
      • "databricks_service_principal": {
        • "application_id": "2d5f7aca-a50c-42ba-bf7d-a30d6594f59f"
        }
      }
    ]
}

Response samples

Content type
application/json
{
  • "workspace": {
    • "name": "my-workspace",
    • "capabilities": {
      • "materializable": true,
      • "offline_store_subdirectory_enabled": true
      },
    • "compute_identities": [
      • {
        • "databricks_service_principal": {
          • "application_id": "2d5f7aca-a50c-42ba-bf7d-a30d6594f59f"
          }
        }
      ],
    • "created_at": "2025-03-20T20:19:37.597046750Z"
    }
}

Feature Service V2

GetFeaturesV2

Get Features V2 API to retrieve feature values from Tecton's online store

Authorizations:
(BearerTecton-key)
path Parameters
params.workspaceName
required
string
params.featureServiceName
required
string

FeatureService name. Exactly one of this field and featureServiceId must be set.

Request Body schema: application/json
required
object (GetFeaturesParametersV2)

featureServiceName and workspaceName must be set. Next ID: 9

object

Join keys used for Batch and Stream FeatureViews.

The key of this map is the join key name and the value is the join key value for this request. The values are encoded as follows:

  • For string keys, the value should be a string.
  • For int64 keys, the value should be a string of the decimal representation of the integer.
object

Request context used for On-Demand Feature Views.

The key of this map is the request context key name and the value is the request context value for this request. The values are encoded as follows:

  • For string values, the value should be a string.
  • For int64 values, the value should be a string of the decimal representation of the integer.
  • For double values, the value should be a number.
object (MetadataOptions)

Options for retrieving additional metadata about the feature values.

allowPartialResults
boolean
Default: "false"

Whether incomplete results should be returned when the Online Feature Store size limit has been exceeded for this request. If this is not true, then the response will be an error in this case. This is different from allowing partial results due to a latency budget, which is controlled with the request_options.latency_budget_ms field.

This is an advanced option and should only be set after consulting with the Tecton team.

object (Request level options to control feature server behavior)

Responses

Request samples

Content type
application/json
{
  • "params": {
    • "featureServiceName": "fraud_detection_feature_service",
    • "workspaceName": "prod",
    • "joinKeyMap": {
      • "user_id": "A123",
      • "ad_id": "5417"
      },
    • "requestContextMap": {
      • "amount": 500
      },
    • "metadataOptions": {
      • "includeSloInfo": true,
      • "includeEffectiveTimes": true,
      • "includeNames": true,
      • "includeDataTypes": true,
      • "includeServingStatus": true
      }
    }
}

Response samples

Content type
application/json
{
  • "result": {
    • "features": [
      • true,
      • null,
      • null,
      • null,
      • "669",
      • 58.349395161290275,
      • 40.13619047619047,
      • 59.59825688073392,
      • 28941.299999999977,
      • 842.8599999999999,
      • 90946.93999999996,
      • [
        • "892054b9598370dce846bb6e4b5805a1",
        • "cc9f13814a736160984bc9896222e4d9",
        • "43a9799c961de6ebb22c122d8c7eb340"
        ]
      ]
    },
  • "metadata": {
    • "features": [
      • {
        • "name": "transaction_amount_is_higher_than_average.transaction_amount_is_higher_than_average",
        • "dataType": {
          • "type": "boolean"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "merchant_fraud_rate.is_fraud_mean_1d_1d",
        • "effectiveTime": "2023-05-03T00:00:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "MISSING_DATA"
        },
      • {
        • "name": "merchant_fraud_rate.is_fraud_mean_30d_1d",
        • "effectiveTime": "2023-05-03T00:00:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "MISSING_DATA"
        },
      • {
        • "name": "merchant_fraud_rate.is_fraud_mean_90d_1d",
        • "effectiveTime": "2023-05-03T00:00:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "MISSING_DATA"
        },
      • {
        • "name": "user_distinct_merchant_transaction_count_30d.distinct_merchant_transaction_count_30d",
        • "effectiveTime": "2023-05-04T00:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "user_transaction_amount_metrics.amt_mean_1d_10m",
        • "effectiveTime": "2023-05-04T15:50:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "user_transaction_amount_metrics.amt_mean_1h_10m",
        • "effectiveTime": "2023-05-04T15:50:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "user_transaction_amount_metrics.amt_mean_3d_10m",
        • "effectiveTime": "2023-05-04T15:50:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "user_transaction_amount_metrics.amt_sum_1d_10m",
        • "effectiveTime": "2023-05-04T15:50:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "user_transaction_amount_metrics.amt_sum_1h_10m",
        • "effectiveTime": "2023-05-04T15:50:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "user_transaction_amount_metrics.amt_sum_3d_10m",
        • "effectiveTime": "2023-05-04T15:50:00Z",
        • "dataType": {
          • "type": "float64"
          },
        • "status": "PRESENT"
        },
      • {
        • "name": "user_transaction_counts.transaction_id_last_3_1d_1d",
        • "effectiveTime": "2023-05-03T00:00:00Z",
        • "dataType": {
          • "type": "array",
          • "elementType": {
            • "type": "string"
            }
          },
        • "status": "PRESENT"
        }
      ],
    • "sloInfo": {
      • "sloEligible": true,
      • "sloServerTimeSeconds": 0.015835683,
      • "dynamodbResponseSizeBytes": 23722,
      • "serverTimeSeconds": 0.016889888,
      • "storeMaxLatency": 0.02687345,
      • "storeResponseSizeBytes": 23722
      }
    }
}

GetFeaturesBatchV2

Batch GetFeatures v2 API to retrieve feature values in batch from Tecton's online store. The maximum batch size for a single batch request is 10. NOTE: This endpoint is only for feature services with Redis feature views.

Authorizations:
(BearerTecton-key)
path Parameters
params.workspaceName
required
string
params.featureServiceName
required
string

FeatureService name.

Request Body schema: application/json
required
object (GetFeaturesBatchParameters)

Parameters for get-features-batch-v2.

featureServiceName must be set.

Array of objects (GetFeaturesBatchRequestData)

Contains individual GetFeatures request parameters in an array. Each array element contains join keys and request contexts corresponding to a single GetFeatures request. The response will return results to each GetFeatures request in the same order that they are specified in the array.

object (MetadataOptions)

Options for retrieving additional metadata about the feature values.

object (Request level options to control feature server behavior)

Responses

Request samples

Content type
application/json
{
  • "params": {
    • "featureServiceName": "fraud_detection_feature_service",
    • "requestData": [
      • {
        • "joinKeyMap": {
          • "user_uuid": "6c423390-9a64-52c8-9bb3-bbb108c74198"
          },
        • "requestContextMap": {
          • "amount": 2000
          }
        },
      • {
        • "joinKeyMap": {
          • "user_uuid": "6c423390-9a64-52c8-9bb3-bbb108c74198"
          },
        • "requestContextMap": {
          • "amount": 500
          }
        }
      ],
    • "workspaceName": "prod",
    • "metadataOptions": {
      • "includeSloInfo": true,
      • "includeEffectiveTimes": true,
      • "includeNames": true,
      • "includeDataTypes": true,
      • "includeServingStatus": true
      }
    }
}

Response samples

Content type
application/json
{
  • "result": [
    • {
      • "features": [
        • null,
        • null,
        • null,
        • "37",
        • "3",
        • "138",
        • "307",
        • "37",
        • "3",
        • "138"
        ]
      },
    • {
      • "features": [
        • null,
        • null,
        • null,
        • "43",
        • null,
        • "128",
        • "254",
        • "43",
        • null,
        • "128"
        ]
      }
    ],
  • "metadata": {
    • "features": [
      • {
        • "name": "user_ad_impression_counts.impression_count_1d_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "MISSING_DATA",
          • "MISSING_DATA"
          ]
        },
      • {
        • "name": "user_ad_impression_counts.impression_count_1h_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "MISSING_DATA",
          • "MISSING_DATA"
          ]
        },
      • {
        • "name": "user_ad_impression_counts.impression_count_3d_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "MISSING_DATA",
          • "MISSING_DATA"
          ]
        },
      • {
        • "name": "user_click_counts.clicked_count_1d_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "PRESENT",
          • "PRESENT"
          ]
        },
      • {
        • "name": "user_click_counts.clicked_count_1h_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "PRESENT",
          • "MISSING_DATA"
          ]
        },
      • {
        • "name": "user_click_counts.clicked_count_3d_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "PRESENT",
          • "PRESENT"
          ]
        },
      • {
        • "name": "user_distinct_ad_count_7d.distinct_ad_count",
        • "effectiveTime": "2023-05-26T00:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "PRESENT",
          • "PRESENT"
          ]
        },
      • {
        • "name": "user_impression_counts.impression_count_1d_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "PRESENT",
          • "PRESENT"
          ]
        },
      • {
        • "name": "user_impression_counts.impression_count_1h_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "PRESENT",
          • "MISSING_DATA"
          ]
        },
      • {
        • "name": "user_impression_counts.impression_count_3d_1h",
        • "effectiveTime": "2023-05-26T18:00:00Z",
        • "dataType": {
          • "type": "int64"
          },
        • "status": [
          • "PRESENT",
          • "PRESENT"
          ]
        }
      ],
    • "sloInfo": [
      • {
        • "sloEligible": true,
        • "sloServerTimeSeconds": 0.001231726,
        • "dynamodbResponseSizeBytes": 1873,
        • "serverTimeSeconds": 0.001231726,
        • "storeMaxLatency": 0.000877174,
        • "storeResponseSizeBytes": 1873
        },
      • {
        • "sloEligible": true,
        • "sloServerTimeSeconds": 0.001329688,
        • "dynamodbResponseSizeBytes": 1937,
        • "serverTimeSeconds": 0.001329688,
        • "storeMaxLatency": 0.000791104,
        • "storeResponseSizeBytes": 1937
        }
      ],
    • "batchSloInfo": {
      • "sloEligible": true,
      • "sloServerTimeSeconds": 0.001329688,
      • "serverTimeSeconds": 0.00181146,
      • "storeMaxLatency": 0.000877174
      }
    }
}

ServiceMetadataV2

Get Metadata V2 API about the feature service from Tecton

Authorizations:
(BearerTecton-key)
path Parameters
workspaceName
required
string

Workspace name.

featureServiceName
required
string

The name of the feature service

Responses

Response samples

Content type
application/json
{
  • "featureServiceType": "DEFAULT",
  • "inputJoinKeys": [
    • {
      • "name": "user_id",
      • "dataType": {
        • "type": "string"
        }
      },
    • {
      • "name": "merchant",
      • "dataType": {
        • "type": "string"
        }
      }
    ],
  • "inputRequestContextKeys": [
    • {
      • "name": "amt",
      • "dataType": {
        • "type": "float64"
        }
      }
    ],
  • "featureValues": [
    • {
      • "name": "transaction_amount_is_higher_than_average.transaction_amount_is_higher_than_average",
      • "dataType": {
        • "type": "boolean"
        }
      },
    • {
      • "name": "merchant_fraud_rate.is_fraud_mean_1d_1d",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "merchant_fraud_rate.is_fraud_mean_30d_1d",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "merchant_fraud_rate.is_fraud_mean_90d_1d",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "user_distinct_merchant_transaction_count_30d.distinct_merchant_transaction_count_30d",
      • "dataType": {
        • "type": "int64"
        }
      },
    • {
      • "name": "user_transaction_amount_metrics.amt_mean_1d_10m",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "user_transaction_amount_metrics.amt_mean_1h_10m",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "user_transaction_amount_metrics.amt_mean_3d_10m",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "user_transaction_amount_metrics.amt_sum_1d_10m",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "user_transaction_amount_metrics.amt_sum_1h_10m",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "user_transaction_amount_metrics.amt_sum_3d_10m",
      • "dataType": {
        • "type": "float64"
        }
      },
    • {
      • "name": "user_transaction_counts.transaction_id_last_3_1d_1d",
      • "dataType": {
        • "type": "array",
        • "elementType": {
          • "type": "string"
          }
        }
      }
    ]
}