YouGuide

API documentation

Travel and language data API reference

What the API covers, how access is authorised, and what the terms of use are. This reference is published alongside the service itself.

Status of this reference

The endpoint reference is not published yet

The API service is not implemented, so there is no base URL, no endpoint reference and no working examples to give you. Those will be published here when the service goes live and can be verified against a real implementation.

The resources below describe the intended shape of the data so you can judge whether it fits what you are building. They are a description of scope, not a contract, and no endpoint paths or sample responses are shown because none of them would answer anything today.

Resources a subscription covers

Travel-guide catalogue
Guide records with stable identifiers, titles, descriptions, destination and category information, and the content languages available for each guide. Filterable and paginated.
Travel-guide content
For a given guide: its table of contents, then ordered chapters and sections with licensed full text.
Language-guide catalogue
Language-guide records with their source and target language pair and metadata.
Language-guide content
For a given language guide: its table of contents, then ordered sections containing phrases, translations, vocabulary, pronunciation guidance, grammar and cultural notes where supplied.
Change feed
Content versions and last-modified information, so you can retrieve only the records that changed since your last sync.

Delivery is structured JSON with supported filtering, pagination, stable identifiers and consistent error responses.

Access and authorisation

  • Access requires an active subscription. A confirmed first payment activates your entitlement — there is no free sandbox with real paid content.
  • API keys are generated only after activation. A key is shown once, stored as a secure hash, and can be rotated or revoked.
  • Every request is checked for authentication, organisation permission, subscription entitlement, dataset scope and quota.
  • Content is licensed for use within your approved application and subscribed scope. It does not include redistribution, publishing rights, model-training rights or ownership.