OPopenmeter
Product Catalog

Create feature

Features are either metered or static. A feature is metered if meterSlug is provided at creation. For metered features you can pass additional filters that will be applied when calculating feature usage, based on the meter's groupBy fields. Meters with SUM, COUNT, UNIQUE_COUNT and LATEST aggregations are supported for features.

post/api/v1/features

Request

  • Base URL
    https://openmeter.cloud (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or API key in cookie __session

Request body

advancedMeterGroupByFiltersobject

Optional advanced meter group by filters. You can use this to filter for values of the meter groupBy fields.

keystring required

A key is a unique string that is used to identify a resource.

metadataMetadata

Set of key-value pairs. Metadata can be used to store additional information about a resource.

meterGroupByFiltersobject

Optional meter group by filters. Useful if the meter scope is broader than what feature tracks. Example scenario would be a meter tracking all token use with groupBy fields for the model, then the feature could filter for model=gpt-4.

⚠️ Deprecated: Use advancedMeterGroupByFilters instead

meterSlugstring

A key is a unique string that is used to identify a resource.

namestring required

Example request

{
  "advancedMeterGroupByFilters": {
    "model": {
      "$in": [
        "gpt-4",
        "gpt-4o"
      ]
    },
    "type": {
      "$eq": "input"
    }
  },
  "metadata": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "meterGroupByFilters": {
    "model": "gpt-4",
    "type": "input"
  },
  "meterSlug": "tokens_total"
}

Response

The request has succeeded and a new resource has been created as a result.

advancedMeterGroupByFiltersobject

Optional advanced meter group by filters. You can use this to filter for values of the meter groupBy fields.

archivedAtstring date-time

Timestamp of when the resource was archived.

createdAtstring date-time required

Timestamp of when the resource was created.

deletedAtstring date-time

Timestamp of when the resource was permanently deleted.

idstring required

Readonly unique ULID identifier.

keystring required

A key is a unique string that is used to identify a resource.

metadataMetadata

Set of key-value pairs. Metadata can be used to store additional information about a resource.

meterGroupByFiltersobject

Optional meter group by filters. Useful if the meter scope is broader than what feature tracks. Example scenario would be a meter tracking all token use with groupBy fields for the model, then the feature could filter for model=gpt-4.

⚠️ Deprecated: Use advancedMeterGroupByFilters instead

meterSlugstring

A key is a unique string that is used to identify a resource.

namestring required
updatedAtstring date-time required

Timestamp of when the resource was last updated.

Example response

{
  "advancedMeterGroupByFilters": {
    "model": {
      "$in": [
        "gpt-4",
        "gpt-4o"
      ]
    },
    "type": {
      "$eq": "input"
    }
  },
  "archivedAt": "2023-01-01T01:01:01.001Z",
  "createdAt": "2024-01-01T01:01:01.001Z",
  "deletedAt": "2024-01-01T01:01:01.001Z",
  "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "metadata": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "meterGroupByFilters": {
    "model": "gpt-4",
    "type": "input"
  },
  "meterSlug": "tokens_total",
  "updatedAt": "2024-01-01T01:01:01.001Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.