Hi team, i have a quick question. One of our user ...
# support
y
Hi team, i have a quick question. One of our user is asking for documentation around the rest API endpoints. I remember we have that, but couldn’t find it now. Could anyone point me to it?
m
Yes! Find the answer in this thread.
y
That makes sense. Sorry for overlooking it I’ll let the user know. So far, I only saw one inquiry about this:)
n
Had a ad-hoc call with o9 just now. They were also using the API directly and having issues. For now, I directed them to use the SDK, but it would be nice to add this back to the docs in a usable manner.
m
Docs and new website: why I removed the API docs from the public site General background: TimeGPT docs were hosted on readme.com via
<http://docs.nixtla.io|docs.nixtla.io>
. This was suboptimal: • Fragmented web presence (3 domains with 3 different platforms:
<http://nixtla.io|nixtla.io>
,
<http://docs.nixtla.io|docs.nixtla.io>
,
<http://nixtlaverse.nixtla.io|nixtlaverse.nixtla.io>
) • Manual work for every update • Poor design • No custom JS unless we paid $3K/month (needed for analytics, tracking, Intercom) What changed: With the new website, we dropped readme.com and now use Mintlify at
<http://nixtla.io/docs|nixtla.io/docs>
. Docs are rendered from simple MDX files. Pros: • Simpler • Looks better • Fully owned and customizable • Full MDX-based, no nbdev dependency. (CMS: Supports visual editing from the mintlify website) Cons: • Not nbdev-based (I see this as a pro) • API section removed • Content was revised for clarity, grammar, and style Why I removed the API reference (arguments):Product: Our SLG strategy targets enterprise users who should use SDKs or integrations (e.g. Snowflake), not raw API calls. SDKs are more stable and feature-rich. • Docs: The old API docs were confusing — multiple versions, beta labels, unclear structure. • Commercial: Only one paying user ($100/month) still calls the API directly. They use Python and should be using the SDK. Can we include the API reference in the new docs? • Yes — Mintlify supports it. We have OpenAPI specs. Should we? • IMO: No — not for now. I aligned with @Nikhil Gupta and @Cristian Challu: we think its not worth the effort at this stage. How can I contribute to the docs? • Code Editing: Currently the docs of timegpt are in the docs folder of our website repo . Follow the instructions in the readme and contact @Edu if you have any troubles. • Visual editing: access https://dashboard.mintlify.com/ and use the CMS tool. cc: @Han Wang, @Cristian Challu, @Olivier Sprangers, @Marco.
n
Thanks for the background and summarizing. My request would be for folks to go through the docs and try to run the code (just for the use cases/sections they are working with customers). Then if you notice something missing or broken, please update the mdx file to include it and submit a PR. I will start by updating the Hierarchical TimeGPT section since I am looking into that.