---
updatedAt: 2026-06-12T14:47:33.000Z
agentTools:
  projectIndex: https://docs.formant.io/llms.txt
---

# List metadata

Resource: streams
Authorized roles: viewer

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "Metadata": {
        "properties": {
          "organizationId": {
            "format": "uuid",
            "type": "string"
          },
          "deviceId": {
            "format": "uuid",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "bitset",
              "localization",
              "point cloud",
              "location",
              "file",
              "health",
              "transform tree",
              "battery",
              "video",
              "numeric set",
              "json",
              "image",
              "numeric",
              "text"
            ]
          },
          "tags": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "flushedToClickhouse": {
            "type": "boolean"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          },
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          }
        },
        "type": "object",
        "required": [
          "organizationId",
          "deviceId",
          "name",
          "type"
        ]
      },
      "MetadataListQuery": {
        "properties": {
          "latestPerDeviceStream": {
            "type": "boolean"
          },
          "tags": {
            "title": "MultiTagSets",
            "description": "One or more TagSets (combined with OR logic)",
            "oneOf": [
              {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/TagSets"
                }
              },
              {
                "$ref": "#/components/schemas/TagSets"
              }
            ]
          },
          "deviceIds": {
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "type": "array"
          },
          "names": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "types": {
            "items": {
              "type": "string",
              "enum": [
                "bitset",
                "localization",
                "point cloud",
                "location",
                "file",
                "health",
                "transform tree",
                "battery",
                "video",
                "numeric set",
                "json",
                "image",
                "numeric",
                "text"
              ]
            },
            "type": "array"
          },
          "notTags": {},
          "notNames": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "agentIds": {
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "type": "array"
          },
          "start": {
            "format": "date-time",
            "type": "string"
          },
          "end": {
            "format": "date-time",
            "type": "string"
          }
        },
        "type": "object"
      },
      "MetadataListResponse": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Metadata"
            },
            "type": "array"
          }
        },
        "type": "object",
        "required": [
          "items"
        ]
      },
      "TagSets": {
        "title": "TagSets",
        "description": "A map of tag keys to an array of values",
        "type": "object",
        "additionalProperties": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "info": {
    "title": "Formant query-api",
    "version": "1.357.8"
  },
  "openapi": "3.0.0",
  "paths": {
    "/metadata": {
      "post": {
        "operationId": "MetadataController.listMetadata",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MetadataListQuery"
              }
            }
          },
          "description": "MetadataListQuery",
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MetadataListResponse"
                }
              }
            },
            "description": ""
          }
        },
        "summary": "List metadata",
        "tags": [
          "Metadata"
        ],
        "description": "Resource: streams\nAuthorized roles: viewer",
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.formant.io/v1/queries"
    }
  ]
}
```