Data sources

Endpoints группы Data sources в API Voiceland AI, с параметрами, схемами и примерами curl.

Последнее обновление: 2026-09-23

Описания endpoints и полей показаны на английском языке, ровно так, как их публикует API. Это наш выбор: здесь вы читаете то же, что увидите в ответах.

GET `/v1/connectors`#

List connectors. Returns the connector presets a data source can use, in display order. Each carries a logo (GET /v1/connectors/{id}/logo.svg, served without a key so a console can show it), the header the provider expects the token in, and whether its mapping is locked (a branded connector whose shape is known) or yours to describe (generic-catalog). text-url takes any URL whose body is already text.

Ответы

Код	Описание
`200`	Success.
`401`	Missing or invalid API key.
`4XX`	Request error (validation, not-found, etc.).
`5XX`	Server or upstream error.

Пример запроса

curl "https://api.voiceland.ai/v1/connectors" \
  -H "Authorization: Bearer VL_API_KEY"

Пример ответа

{
  "items": [
    {
      "auth_header": "access_token",
      "default_refresh_s": 3600,
      "description": "Menu and catalogue of an iotSoft kiosk.",
      "id": "iotsoft",
      "logo": "/v1/connectors/iotsoft/logo.svg",
      "mapping_locked": true,
      "name": "iotSoft",
      "order": 1,
      "transform": "catalog",
      "url_placeholder": "https://example.com/api/menu",
      "vendor": "iotSoft"
    }
  ]
}

GET `/v1/data-sources`#

List data sources. Returns your data sources with the metadata of their latest snapshot, status, size, when it was fetched. Never the token and never the text; the preview route returns the text.

Ответы

Код	Описание
`200`	Success.
`401`	Missing or invalid API key.
`4XX`	Request error (validation, not-found, etc.).
`5XX`	Server or upstream error.

Пример запроса

curl "https://api.voiceland.ai/v1/data-sources" \
  -H "Authorization: Bearer VL_API_KEY"

Пример ответа

{
  "items": [
    {
      "auth_header": "access_token",
      "connector_id": "iotsoft",
      "connector_name": "iotSoft",
      "created_at": "2026-09-13T12:00:00Z",
      "enabled": true,
      "has_secret": true,
      "id": "ds-3d60ba7619",
      "max_prompt_chars": 15000,
      "name": "Menu (iotSoft)",
      "next_due_at": "2026-09-13T13:00:00Z",
      "refresh_interval_s": 3600,
      "secret_name": "ds-3d60ba7619",
      "snapshot": {
        "categories": 14,
        "changed": true,
        "chars": 14792,
        "checked_at": "2026-09-13T13:00:00Z",
        "duration_ms": 1070,
        "fetched_at": "2026-09-13T12:00:00Z",
        "hash": "9f1c2e…",
        "items": 166,
        "status": "ok"
      },
      "transform": "catalog",
      "updated_at": "2026-09-13T12:00:00Z",
      "url": "https://example.com/api/menu"
    }
  ]
}

POST `/v1/data-sources`#

Create a data source. Creates a data source and fetches it once before answering (under the refresh lease, so a background node cannot fetch it a second time), so the response carries the first snapshot and you see at once whether the URL, token and mapping work. token is write-only: it is stored as a secret named after the source and no read ever returns it. refresh_interval_s is clamped to at least 300 (default 3600); max_prompt_chars defaults to 15000. A branded connector ignores mapping; generic-catalog requires one that validates. Attach the returned id to an agent through its data_sources list.

Тело запроса

application/json Схема: DataSourceRequest

Поле	Тип	Обязательно	Описание
`auth_header`	string
`connector_id`	string	Да
`enabled`	boolean
`mapping`	`CatalogMapping`		Dot-separated paths from the response root describing a JSON catalogue.
`max_prompt_chars`	integer
`name`	string	Да
`refresh_interval_s`	integer
`token`	string
`url`	string	Да

Ответы

Код	Описание
`201`	Created, with the first snapshot.
`400`	`unknown_connector`, `invalid_url` (must start with http:// or https://), `url_not_allowed` (a loopback, private-network or cloud-metadata address, the message names the rule) or `invalid_mapping` (the message names the missing path).
`401`	Missing or invalid API key.
`4XX`	Request error (validation, not-found, etc.).
`5XX`	Server or upstream error.

Пример запроса

curl -X POST "https://api.voiceland.ai/v1/data-sources" \
  -H "Authorization: Bearer VL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "connector_id": "iotsoft",
  "name": "Menu (iotSoft)",
  "refresh_interval_s": 3600,
  "token": "kiosk_xxxxxxxxxxxxxxxx",
  "url": "https://example.com/api/menu"
}'

Успешный ответ возвращает DataSourceView.

Пример ответа

{
  "auth_header": "access_token",
  "connector_id": "iotsoft",
  "connector_name": "iotSoft",
  "created_at": "2026-09-13T12:00:00Z",
  "enabled": true,
  "has_secret": true,
  "id": "ds-3d60ba7619",
  "max_prompt_chars": 15000,
  "name": "Menu (iotSoft)",
  "next_due_at": "2026-09-13T13:00:00Z",
  "refresh_interval_s": 3600,
  "secret_name": "ds-3d60ba7619",
  "snapshot": {
    "categories": 14,
    "changed": true,
    "chars": 14792,
    "checked_at": "2026-09-13T13:00:00Z",
    "duration_ms": 1070,
    "fetched_at": "2026-09-13T12:00:00Z",
    "hash": "9f1c2e…",
    "items": 166,
    "status": "ok"
  },
  "transform": "catalog",
  "updated_at": "2026-09-13T12:00:00Z",
  "url": "https://example.com/api/menu"
}

DELETE `/v1/data-sources/{id}`#

Delete a data source. Deletes the source and the secret holding its token. An agent that still lists the id skips it at call time.

Параметры

Имя	Место	Тип	Обязательно	Описание
`id`	`path`	string	Да	Data source id (`ds-…`).

Ответы

Код	Описание
`204`	Deleted.
`401`	Missing or invalid API key.
`4XX`	Request error (validation, not-found, etc.).
`5XX`	Server or upstream error.

Пример запроса

curl -X DELETE "https://api.voiceland.ai/v1/data-sources/{id}" \
  -H "Authorization: Bearer VL_API_KEY"

GET `/v1/data-sources/{id}`#

Get a data source. Returns one data source with its latest snapshot metadata.

Параметры

Имя	Место	Тип	Обязательно	Описание
`id`	`path`	string	Да	Data source id (`ds-…`).

Ответы

Код	Описание
`200`	Success.
`401`	Missing or invalid API key.
`4XX`	Request error (validation, not-found, etc.).
`5XX`	Server or upstream error.

Пример запроса

curl "https://api.voiceland.ai/v1/data-sources/{id}" \
  -H "Authorization: Bearer VL_API_KEY"

Успешный ответ возвращает DataSourceView.

Пример ответа

{
  "auth_header": "access_token",
  "connector_id": "iotsoft",
  "connector_name": "iotSoft",
  "created_at": "2026-09-13T12:00:00Z",
  "enabled": true,
  "has_secret": true,
  "id": "ds-3d60ba7619",
  "max_prompt_chars": 15000,
  "name": "Menu (iotSoft)",
  "next_due_at": "2026-09-13T13:00:00Z",
  "refresh_interval_s": 3600,
  "secret_name": "ds-3d60ba7619",
  "snapshot": {
    "categories": 14,
    "changed": true,
    "chars": 14792,
    "checked_at": "2026-09-13T13:00:00Z",
    "duration_ms": 1070,
    "fetched_at": "2026-09-13T12:00:00Z",
    "hash": "9f1c2e…",
    "items": 166,
    "status": "ok"
  },
  "transform": "catalog",
  "updated_at": "2026-09-13T12:00:00Z",
  "url": "https://example.com/api/menu"
}

PUT `/v1/data-sources/{id}`#

Update a data source. Replaces the source's settings and fetches it again before answering. Omit token to keep the stored one; send enabled: false to stop refreshing and stop injecting without deleting.

Параметры

Имя	Место	Тип	Обязательно	Описание
`id`	`path`	string	Да	Data source id (`ds-…`).

Тело запроса

application/json Схема: DataSourceRequest

Поле	Тип	Обязательно	Описание
`auth_header`	string
`connector_id`	string	Да
`enabled`	boolean
`mapping`	`CatalogMapping`		Dot-separated paths from the response root describing a JSON catalogue.
`max_prompt_chars`	integer
`name`	string	Да
`refresh_interval_s`	integer
`token`	string
`url`	string	Да

Ответы

Код	Описание
`200`	Success.
`401`	Missing or invalid API key.
`4XX`	Request error (validation, not-found, etc.).
`5XX`	Server or upstream error.

Пример запроса

curl -X PUT "https://api.voiceland.ai/v1/data-sources/{id}" \
  -H "Authorization: Bearer VL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "connector_id": "iotsoft",
  "name": "Menu (iotSoft)",
  "refresh_interval_s": 3600,
  "token": "kiosk_xxxxxxxxxxxxxxxx",
  "url": "https://example.com/api/menu"
}'

Успешный ответ возвращает DataSourceView.

Пример ответа

{
  "auth_header": "access_token",
  "connector_id": "iotsoft",
  "connector_name": "iotSoft",
  "created_at": "2026-09-13T12:00:00Z",
  "enabled": true,
  "has_secret": true,
  "id": "ds-3d60ba7619",
  "max_prompt_chars": 15000,
  "name": "Menu (iotSoft)",
  "next_due_at": "2026-09-13T13:00:00Z",
  "refresh_interval_s": 3600,
  "secret_name": "ds-3d60ba7619",
  "snapshot": {
    "categories": 14,
    "changed": true,
    "chars": 14792,
    "checked_at": "2026-09-13T13:00:00Z",
    "duration_ms": 1070,
    "fetched_at": "2026-09-13T12:00:00Z",
    "hash": "9f1c2e…",
    "items": 166,
    "status": "ok"
  },
  "transform": "catalog",
  "updated_at": "2026-09-13T12:00:00Z",
  "url": "https://example.com/api/menu"
}

GET `/v1/data-sources/{id}/preview`#

Preview the text. Returns the exact text the agent reads at call start, with the snapshot metadata. The only route that returns the text.

Параметры

Имя	Место	Тип	Обязательно	Описание
`id`	`path`	string	Да	Data source id (`ds-…`).

Ответы

Код	Описание
`200`	Success.
`401`	Missing or invalid API key.
`4XX`	Request error (validation, not-found, etc.).
`5XX`	Server or upstream error.

Пример запроса

curl "https://api.voiceland.ai/v1/data-sources/{id}/preview" \
  -H "Authorization: Bearer VL_API_KEY"

Пример ответа

{
  "id": "ds-3d60ba7619",
  "snapshot": {
    "categories": 14,
    "changed": true,
    "chars": 14792,
    "checked_at": "2026-09-13T13:00:00Z",
    "duration_ms": 1070,
    "fetched_at": "2026-09-13T12:00:00Z",
    "hash": "9f1c2e…",
    "items": 166,
    "status": "ok"
  },
  "text": "## ΠΙΤΕΣ (όλα: πατάτες, ντομάτα, κρεμμύδι)\n- Πίτα γύρος χοιρινό, 4,50 €\n  σάλτσα (επιλογή 1): τζατζίκι, μουστάρδα …"
}

POST `/v1/data-sources/{id}/refresh`#

Refresh now. Fetches the source outside its schedule and returns it with the result. A fetch that finds the same text advances snapshot.checked_at and the schedule and rewrites nothing; a failed fetch keeps the previous text in use and notes the reason in snapshot.error.

Параметры

Имя	Место	Тип	Обязательно	Описание
`id`	`path`	string	Да	Data source id (`ds-…`).

Ответы

Код	Описание
`200`	Success.
`401`	Missing or invalid API key.
`409`	`refresh_in_progress`, another node is fetching this source right now; try again in a moment.
`4XX`	Request error (validation, not-found, etc.).
`5XX`	Server or upstream error.

Пример запроса

curl -X POST "https://api.voiceland.ai/v1/data-sources/{id}/refresh" \
  -H "Authorization: Bearer VL_API_KEY"

Успешный ответ возвращает DataSourceView.

Пример ответа

{
  "auth_header": "access_token",
  "connector_id": "iotsoft",
  "connector_name": "iotSoft",
  "created_at": "2026-09-13T12:00:00Z",
  "enabled": true,
  "has_secret": true,
  "id": "ds-3d60ba7619",
  "max_prompt_chars": 15000,
  "name": "Menu (iotSoft)",
  "next_due_at": "2026-09-13T13:00:00Z",
  "refresh_interval_s": 3600,
  "secret_name": "ds-3d60ba7619",
  "snapshot": {
    "categories": 14,
    "changed": true,
    "chars": 14792,
    "checked_at": "2026-09-13T13:00:00Z",
    "duration_ms": 1070,
    "fetched_at": "2026-09-13T12:00:00Z",
    "hash": "9f1c2e…",
    "items": 166,
    "status": "ok"
  },
  "transform": "catalog",
  "updated_at": "2026-09-13T12:00:00Z",
  "url": "https://example.com/api/menu"
}

Схемы#

CatalogMapping#

Dot-separated paths from the response root describing a JSON catalogue.

Поле	Тип	Обязательно	Описание
`category_name`	string	Да
`choice_group_hints`	array of string		Substrings that mark a group as a choice regardless of its size.
`currency`	string
`drop_gibberish`	boolean		Drop option entries that are not words.
`group_item_name`	string
`group_item_price`	array of string
`group_items`	string
`group_max`	string		Field carrying how many options may be chosen. A free group allowing more than two is read as the item's contents; at most two, as a choice.
`group_name`	string
`group_required`	string
`groups_path`	string
`ingredient_name`	string
`ingredients_path`	string
`item_description`	string
`item_name`	string	Да
`item_price`	array of string	Да	One or more fields; the first present wins.
`items_path`	string	Да
`list_path`	string	Да
`skip_categories`	array of string		Category names to drop (fees, staff-only, raw materials).

DataSourceRequest#

Поле	Тип	Обязательно	Описание
`auth_header`	string
`connector_id`	string	Да
`enabled`	boolean
`mapping`	`CatalogMapping`		Dot-separated paths from the response root describing a JSON catalogue.
`max_prompt_chars`	integer
`name`	string	Да
`refresh_interval_s`	integer
`token`	string
`url`	string	Да

DataSourceSnapshot#

Metadata of the latest fetch. The text itself is only on the preview route.

Поле	Тип	Обязательно	Описание
`categories`	integer
`changed`	boolean	Да	Whether the last fetch produced different text from the one before. An unchanged fetch writes only the schedule and `checked_at`.
`chars`	integer	Да	Size of the text the agent reads, after the cap.
`checked_at`	string (date-time)		The last successful fetch. A fetch that finds the same text advances only this (and the schedule); nothing else is rewritten.
`duration_ms`	integer
`error`	string		Why the last fetch failed: the reason when status is `error`, or `last refresh failed: …` on a source still serving its previous good text.
`fetched_at`	string (date-time)	Да	When the current text was captured, i.e. the last fetch that changed it.
`hash`	string
`items`	integer
`status`	string	Да	`ok` or `error`. A fetch that fails after a good one keeps `ok`, keeps the text, and notes the failure in `error`; only a source that never succeeded is `error`.

DataSourceView#

Поле	Тип	Обязательно	Описание
`auth_header`	string
`connector_id`	string	Да
`connector_name`	string
`created_at`	string (date-time)	Да
`enabled`	boolean	Да
`has_secret`	boolean	Да
`id`	string	Да
`mapping`	`CatalogMapping`		Dot-separated paths from the response root describing a JSON catalogue.
`max_prompt_chars`	integer
`name`	string	Да
`next_due_at`	string (date-time)	Да	When the next background fetch is due.
`refresh_interval_s`	integer	Да
`secret_name`	string		Name of the secret holding the token (`ds-<id>`). Absent when no token was given.
`snapshot`	`DataSourceSnapshot`		Metadata of the latest fetch. The text itself is only on the preview route.
`transform`	string	Да	`catalog` (categories, items, prices, option groups) or `passthrough` (the body as text).
`updated_at`	string (date-time)	Да
`url`	string	Да

Error#

Error envelope returned for non-2xx responses.

Поле	Тип	Обязательно	Описание
`error`	object	Да

GET /v1/connectors#

Ответы

Пример запроса

Пример ответа

GET /v1/data-sources#

Ответы

Пример запроса

Пример ответа

POST /v1/data-sources#

Тело запроса

Ответы

Пример запроса

Пример ответа

DELETE /v1/data-sources/{id}#

Параметры

Ответы

Пример запроса

GET /v1/data-sources/{id}#

Параметры

Ответы

Пример запроса

Пример ответа

PUT /v1/data-sources/{id}#

Параметры

Тело запроса

Ответы

Пример запроса

Пример ответа

GET /v1/data-sources/{id}/preview#

Параметры

Ответы

Пример запроса

Пример ответа

POST /v1/data-sources/{id}/refresh#

Параметры

Ответы

Пример запроса

Пример ответа

Схемы#

CatalogMapping#

DataSourceRequest#

DataSourceSnapshot#

DataSourceView#

Error#

Консоль

GET `/v1/connectors`#

GET `/v1/data-sources`#

POST `/v1/data-sources`#

DELETE `/v1/data-sources/{id}`#

GET `/v1/data-sources/{id}`#

PUT `/v1/data-sources/{id}`#

GET `/v1/data-sources/{id}/preview`#

POST `/v1/data-sources/{id}/refresh`#