HTTP API

Geo

GET/api/v1/geo

List_geo_indexes

GET
/api/v1/geo

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Query Parameters

q?string

Full-text search query

active?boolean

Filter by active status

owner_id?string

Filter by owner

page?integer

Page number (1-indexed)

Formatint64
Range0 <= value
page_size?integer

Page size

Formatint64
Range0 <= value
sort_by?string

Sort field (e.g., "created_at", "name")

sort_order?string

Sort order (asc or desc)

Value in

  • "asc"
  • "desc"
filter?array<string>

Additional filter expressions

Response Body

application/json

curl -X GET "https://example.com/api/v1/geo"
{  "indexes": [    {      "active": true,      "config": {        "default_limit": 0,        "entity_ttl_seconds": 0,        "max_entities": 0,        "max_limit": 0,        "max_radius_meters": 0.1      },      "created_at": 0,      "description": "string",      "entity_count": 0,      "id": "string",      "name": "string",      "owner_id": "string",      "tags": {        "property1": "string",        "property2": "string"      },      "updated_at": 0    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}
POST/api/v1/geo

Create_geo_index

POST
/api/v1/geo

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/geo" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "created_at": 0,  "id": "string",  "name": "string"}
GET/api/v1/geo/{id}

Get_geo_index

GET
/api/v1/geo/{id}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

Response Body

application/json

curl -X GET "https://example.com/api/v1/geo/string"
{  "active": true,  "config": {    "default_limit": 0,    "entity_ttl_seconds": 0,    "max_entities": 0,    "max_limit": 0,    "max_radius_meters": 0.1  },  "created_at": 0,  "description": "string",  "entity_count": 0,  "id": "string",  "name": "string",  "owner_id": "string",  "tags": {    "property1": "string",    "property2": "string"  },  "updated_at": 0}
PATCH/api/v1/geo/{id}

Update_geo_index

PATCH
/api/v1/geo/{id}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/api/v1/geo/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "active": true,  "config": {    "default_limit": 0,    "entity_ttl_seconds": 0,    "max_entities": 0,    "max_limit": 0,    "max_radius_meters": 0.1  },  "created_at": 0,  "description": "string",  "entity_count": 0,  "id": "string",  "name": "string",  "owner_id": "string",  "tags": {    "property1": "string",    "property2": "string"  },  "updated_at": 0}
DELETE/api/v1/geo/{id}

Delete_geo_index

DELETE
/api/v1/geo/{id}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

Response Body

curl -X DELETE "https://example.com/api/v1/geo/string"
Empty
GET/api/v1/geo/{id}/distance

Entity_distance

GET
/api/v1/geo/{id}/distance

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

Query Parameters

from_entity_id*string
to_entity_id*string
unit?string

Response Body

application/json

curl -X GET "https://example.com/api/v1/geo/string/distance?from_entity_id=string&to_entity_id=string"
{  "distance": 0.1,  "from_entity_id": "string",  "index_id": "string",  "to_entity_id": "string",  "unit": "string"}
GET/api/v1/geo/{id}/entities

List_entities

GET
/api/v1/geo/{id}/entities

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

Query Parameters

limit?integer
Range0 <= value

Response Body

application/json

curl -X GET "https://example.com/api/v1/geo/string/entities"
{  "count": 0,  "entities": [    {      "distance_meters": 0,      "entity_id": "string",      "last_updated": 0,      "latitude": 0.1,      "longitude": 0.1,      "metadata": null    }  ],  "index_id": "string"}
POST/api/v1/geo/{id}/entities

Update_location

POST
/api/v1/geo/{id}/entities

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/geo/string/entities" \  -H "Content-Type: application/json" \  -d '{    "entity_id": "string",    "latitude": 0.1,    "longitude": 0.1  }'
{  "entity_id": "string",  "index_id": "string",  "latitude": 0.1,  "longitude": 0.1,  "updated_at": 0}
POST/api/v1/geo/{id}/entities/batch

Batch_update_location

POST
/api/v1/geo/{id}/entities/batch

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/geo/string/entities/batch" \  -H "Content-Type: application/json" \  -d '{    "entities": [      {        "entity_id": "string",        "latitude": 0.1,        "longitude": 0.1      }    ]  }'
{  "index_id": "string",  "updated": 0}
GET/api/v1/geo/{id}/entities/{entity_id}

Get_entity

GET
/api/v1/geo/{id}/entities/{entity_id}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

entity_id*string

Entity ID

Response Body

application/json

curl -X GET "https://example.com/api/v1/geo/string/entities/string"
{  "entity": {    "distance_meters": 0,    "entity_id": "string",    "last_updated": 0,    "latitude": 0.1,    "longitude": 0.1,    "metadata": null  },  "index_id": "string"}
DELETE/api/v1/geo/{id}/entities/{entity_id}

Delete_entity

DELETE
/api/v1/geo/{id}/entities/{entity_id}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

entity_id*string

Entity ID to delete

Response Body

application/json

curl -X DELETE "https://example.com/api/v1/geo/string/entities/string"
{  "deleted": true,  "entity_id": "string",  "index_id": "string"}
GET/api/v1/geo/{id}/fences

List_geo_fences

GET
/api/v1/geo/{id}/fences

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

Query Parameters

q?string
active?boolean
page?integer
Formatint64
Range0 <= value
page_size?integer
Formatint64
Range0 <= value
sort_by?string
sort_order?string

Value in

  • "asc"
  • "desc"
filter?array<string>

Response Body

application/json

curl -X GET "https://example.com/api/v1/geo/string/fences"
{  "fences": [    {      "active": true,      "center_latitude": 0.1,      "center_longitude": 0.1,      "created_at": 0,      "description": "string",      "id": "string",      "index_id": "string",      "name": "string",      "owner_id": "string",      "radius_meters": 0.1,      "shape": "circle",      "tags": {        "property1": "string",        "property2": "string"      },      "updated_at": 0,      "vertices": [        {          "latitude": 0.1,          "longitude": 0.1        }      ]    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}
POST/api/v1/geo/{id}/fences

Create_geo_fence

POST
/api/v1/geo/{id}/fences

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/geo/string/fences" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "shape": "circle"  }'
{  "active": true,  "center_latitude": 0.1,  "center_longitude": 0.1,  "created_at": 0,  "description": "string",  "id": "string",  "index_id": "string",  "name": "string",  "owner_id": "string",  "radius_meters": 0.1,  "shape": "circle",  "tags": {    "property1": "string",    "property2": "string"  },  "updated_at": 0,  "vertices": [    {      "latitude": 0.1,      "longitude": 0.1    }  ]}
GET/api/v1/geo/{id}/fences/{fence_id}

Get_geo_fence

GET
/api/v1/geo/{id}/fences/{fence_id}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

fence_id*string

Geo fence ID

Response Body

application/json

curl -X GET "https://example.com/api/v1/geo/string/fences/string"
{  "active": true,  "center_latitude": 0.1,  "center_longitude": 0.1,  "created_at": 0,  "description": "string",  "id": "string",  "index_id": "string",  "name": "string",  "owner_id": "string",  "radius_meters": 0.1,  "shape": "circle",  "tags": {    "property1": "string",    "property2": "string"  },  "updated_at": 0,  "vertices": [    {      "latitude": 0.1,      "longitude": 0.1    }  ]}
PATCH/api/v1/geo/{id}/fences/{fence_id}

Update_geo_fence

PATCH
/api/v1/geo/{id}/fences/{fence_id}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

fence_id*string

Geo fence ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/api/v1/geo/string/fences/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "active": true,  "center_latitude": 0.1,  "center_longitude": 0.1,  "created_at": 0,  "description": "string",  "id": "string",  "index_id": "string",  "name": "string",  "owner_id": "string",  "radius_meters": 0.1,  "shape": "circle",  "tags": {    "property1": "string",    "property2": "string"  },  "updated_at": 0,  "vertices": [    {      "latitude": 0.1,      "longitude": 0.1    }  ]}
DELETE/api/v1/geo/{id}/fences/{fence_id}

Delete_geo_fence

DELETE
/api/v1/geo/{id}/fences/{fence_id}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

fence_id*string

Geo fence ID

Response Body

curl -X DELETE "https://example.com/api/v1/geo/string/fences/string"
Empty
GET/api/v1/geo/{id}/fences/{fence_id}/check

Check_geo_fence

GET
/api/v1/geo/{id}/fences/{fence_id}/check

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

fence_id*string

Geo fence ID

Query Parameters

longitude*number
Formatdouble
latitude*number
Formatdouble

Response Body

application/json

curl -X GET "https://example.com/api/v1/geo/string/fences/string/check?longitude=0.1&latitude=0.1"
{  "distance_meters": 0.1,  "fence_id": "string",  "inside": true}
GET/api/v1/geo/{id}/query/bbox

Query_bounding_box

GET
/api/v1/geo/{id}/query/bbox

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

Query Parameters

min_longitude*number
Formatdouble
min_latitude*number
Formatdouble
max_longitude*number
Formatdouble
max_latitude*number
Formatdouble
limit?integer
Range0 <= value
with_coordinates?boolean

Response Body

application/json

curl -X GET "https://example.com/api/v1/geo/string/query/bbox?min_longitude=0.1&min_latitude=0.1&max_longitude=0.1&max_latitude=0.1"
{  "entities": [    {      "distance_meters": 0,      "entity_id": "string",      "last_updated": 0,      "latitude": 0.1,      "longitude": 0.1,      "metadata": null    }  ],  "query_bounds": null,  "query_center": null,  "timestamp": 0,  "total_found": 0}
GET/api/v1/geo/{id}/query/radius

Query_radius

GET
/api/v1/geo/{id}/query/radius

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

Query Parameters

longitude*number
Formatdouble
latitude*number
Formatdouble
radius_meters*number
Formatdouble
unit?string
limit?integer
Range0 <= value
with_distance?boolean
with_coordinates?boolean

Response Body

application/json

curl -X GET "https://example.com/api/v1/geo/string/query/radius?longitude=0.1&latitude=0.1&radius_meters=0.1"
{  "entities": [    {      "distance_meters": 0,      "entity_id": "string",      "last_updated": 0,      "latitude": 0.1,      "longitude": 0.1,      "metadata": null    }  ],  "query_bounds": null,  "query_center": null,  "timestamp": 0,  "total_found": 0}
GET/api/v1/geo/{id}/stats

Get_index_stats

GET
/api/v1/geo/{id}/stats

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Geo index ID

Response Body

application/json

curl -X GET "https://example.com/api/v1/geo/string/stats"
{  "bounds": null,  "entity_count": 0,  "index_id": "string",  "index_name": "string",  "last_update": 0}

FSM

Finite State Machine management

Guild

Guild management and membership

On this page

List_geo_indexesCreate_geo_indexGet_geo_indexUpdate_geo_indexDelete_geo_indexEntity_distanceList_entitiesUpdate_locationBatch_update_locationGet_entityDelete_entityList_geo_fencesCreate_geo_fenceGet_geo_fenceUpdate_geo_fenceDelete_geo_fenceCheck_geo_fenceQuery_bounding_boxQuery_radiusGet_index_stats