The service document is the entry point of the OData v4 feed: it lists one
entity per published table (*_gold/*_silver) in the workspace. Power BI and Excel
discover the feeds from here.
Summary#
| Method · route | GET /api/v1/odata |
| Base | https://ingestia.io |
| Auth | API key (Authorization: Bearer ing_live_… or ?api_key=) |
| Role (RBAC) | data export (member+); data key = owner |
| Cost | R$ 0 (discovering entities does not trigger a paid job) |
| Headers | OData-Version: 4.0 · X-Ingestia-Access-Scope: workspace |
| Statuses | 200 · 401 · 403 · 429 · 402 · 503 |
Parameters#
None. It also responds to OPTIONS (CORS preflight).
Example#
curl -H "Authorization: Bearer ing_live_EXEMPLO" \
https://ingestia.io/api/v1/odataconst res = await fetch("https://ingestia.io/api/v1/odata", {
headers: { Authorization: "Bearer ing_live_EXEMPLO" },
});
const servico = await res.json();import requests
res = requests.get(
"https://ingestia.io/api/v1/odata",
headers={"Authorization": "Bearer ing_live_EXEMPLO"},
)
servico = res.json()200 response#
json
{
"@odata.context": "https://ingestia.io/api/v1/odata/$metadata",
"value": [
{ "name": "vendas", "kind": "EntitySet", "url": "vendas" }
]
}For the column types (EDMX), see
GET /api/v1/odata/$metadata.
Notes#
- The entities in the service document are identical to those in
$metadata— same governance allowlist (PII excluded, always). - With no datalake provisioned, the feed responds
503in production (it never fakes).
Errors#
| Code | When |
|---|---|
401 | missing/invalid key |
403 | insufficient role/scope |
429 · 402 | rate limit (120/min per key) / overdue payment |
503 | datalake not provisioned / own cloud down / limiter unavailable |
Security#
- Read-only, scoped to the workspace (published marts only).
- PII columns do not appear in the service document or in
$metadata.
Related#
Last reviewed: 2026-09-08.