Skip to main content
POST
/
entities
curl --request POST \
  --url https://api.geogen.io/v1/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Mon Site",
  "domain": "example.fr",
  "description": "Plateforme de gestion de projet pour les équipes distantes",
  "language": "fr",
  "geolocation": "fr",
  "trackingType": "website",
  "models": [
    "model-uuid-1",
    "model-uuid-2"
  ],
  "prompts": [
    "Quel est le meilleur outil de gestion de projet pour les équipes à distance ?",
    "Quels logiciels recommandez-vous pour la collaboration en ligne ?",
    "Quelles sont les meilleures alternatives à Trello en France ?"
  ],
  "startTracking": true
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "target": "<string>",
    "targetType": "url",
    "description": "<string>",
    "faviconUrl": "<string>",
    "language": "<string>",
    "geolocation": "<string>",
    "isActive": true
  },
  "promptsGenerated": 123,
  "prompts": [
    {
      "id": "<string>",
      "prompt": "<string>",
      "language": "<string>",
      "geolocation": "<string>"
    }
  ],
  "trackingStarted": true,
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key authentication. Format: Bearer wsk_your_api_key

Body

application/json
​
name
string
required

Entity display name

​
domain
string
required

Website domain (e.g., example.com)

​
models
string[]
required

Array of model UUIDs from /v1/models

​
description
string

Entity description

​
language
string
default:en

Language code for the entity (e.g., 'en', 'fr', 'de'). Used as default for auto-generated prompts and for custom prompts that don't specify their own language.

​
geolocation
string
default:global

Geolocation code for the entity (e.g., 'global', 'us', 'gb'). Used as default for auto-generated prompts and for custom prompts that don't specify their own geolocation.

​
trackingType
enum<string>
default:website

Type of tracking

Available options:
website,
individual
​
prompts
(string | object)[]

Custom prompts for tracking. Each item can be a plain string (inherits entity's language/geolocation) or an object with per-prompt language/geolocation overrides. When provided, auto-generation is skipped.

Prompt text (uses entity's language and geolocation)

​
generatePrompts
boolean
default:true

Whether to auto-generate prompts using AI. Ignored when the prompts array is provided. Set to false to create the entity without any prompts.

​
startTracking
boolean
default:true

Start tracking immediately

Response

Entity created successfully

​
success
boolean
​
data
object
​
promptsGenerated
number

Number of prompts saved for this entity (0 if generatePrompts was false and no custom prompts were provided)

​
prompts
object[]

The saved prompts for this entity. Each prompt has its own language and geolocation (either per-prompt override or inherited from the entity).

​
trackingStarted
boolean
​
message
string