---
updatedAt: 2025-06-04T20:42:43.000Z
agentTools:
  projectIndex: https://docs.tomorrow.io/llms.txt
---

# Custom Vector Events API

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "tomorrowio-api",
    "version": "4.0.1"
  },
  "servers": [
    {
      "url": "https://api.tomorrow.io/v4"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "query",
        "name": "apikey"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/events-custom/{feedName}.{format}": {
      "post": {
        "summary": "Custom Vector Events API",
        "description": "",
        "operationId": "custom-vector-events-api",
        "parameters": [
          {
            "name": "feedName",
            "in": "path",
            "description": "The nama of your custom feed",
            "schema": {
              "type": "string",
              "default": "sample"
            },
            "required": true
          },
          {
            "name": "format",
            "in": "path",
            "description": "'json' or 'geojson' are supported",
            "schema": {
              "type": "string",
              "default": "geojson"
            },
            "required": true
          },
          {
            "name": "Accept-Encoding",
            "in": "header",
            "schema": {
              "type": "string",
              "default": "application/json"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "timeRange": {
                    "type": "object",
                    "description": "Duration to get the feed results for. Times should follow the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)",
                    "properties": {}
                  },
                  "geofence": {
                    "type": "object",
                    "description": "Fields: geojsonGeometry (object; required) – Valid GeoJSON geometry (e.g., Polygon or MultiPolygon). type (string; required) – The GeoJSON geometry type (e.g., \"Polygon\"). coordinates (array; required) – The coordinates defining the polygon.",
                    "properties": {}
                  },
                  "attributes": {
                    "type": "object",
                    "description": "insightId (string) – The unique ID of the triggered insight. insightName (string) – The name of the insight. locationId (string) – An identifier for the location category. severity (string) – The severity of the event. insightDescription (string) – The textual description of the insight.",
                    "properties": {}
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{{\n    \"events\": [\n        {\n            \"id\": 0,\n            \"object_key\": \"01a4bfa1dd4440ae1793da45e6cc89d0\",\n            \"start\": \"2025-01-07T00:00:00Z\",\n            \"end\": \"2025-01-07T01:00:00Z\",\n            \"locations\": [\n                {\n                    \"geojsonGeometry\": {\n                        \"coordinates\": [\n                            [\n                                [\n                                    -103.359375,\n                                    51.07806342227867\n                                ],\n                                [\n                                    -103.18359374999999,\n                                    51.07806342227867\n                                ],\n                                [\n                                    -103.18359374999999,\n                                    51.18841342098831\n                                ],\n                                [\n                                    -103.359375,\n                                    51.18841342098831\n                                ],\n                                [\n                                    -103.359375,\n                                    51.07806342227867\n                                ]\n                            ]\n                        ],\n                        \"type\": \"Polygon\"\n                    }\n                }\n            ],\n            \"attributes\": {\n                \"accountId\": \"63fe3264e5b2f04fc03edb7f\",\n                \"insightDescription\": \"Visibility of less than 0.1 miles expected in this zipcode.\\nTransportation disruptions, increased risk of accidents or collisions.\",\n                \"insightId\": \"d502ddf0-fff3-4d6b-935b-6c642007b8be\",\n                \"insightName\": \"Extremely Low Visibility\",\n                \"locationId\": \"us_continental\",\n                \"severity\": \"minor\"\n            }\n        }"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```