Share Tinybird Endpoint documentation¶
Learn how to share your Tinybird Endpoint documentation with development teams.
The Tinybird Endpoint page¶
When you publish an Endpoint, Tinybird generates a documentation page for you that is ready to share and compatible with OpenAPI 3.0. It contains your Endpoint description, information about the dynamic parameters you can use when querying this Endpoint, and code snippets for quickly integrating your API in third-party applications.
To share your published Endpoint, navigate to the "Create Chart" button (Tinybird UI) > "Share this API endpoint" modal:
Use Static Tokens to define Endpoint subsets¶
Tinybird authentication is based on Tokens which contain different scopes for specific resources. For example, a Token you can read from one or many Endpoints, or get write permissions for a particular Data Source.
If you take a closer look at the URLs generated for sharing a public Endpoint page, you see that after the Endpoint ID, it includes a Token parameter. This means that this page is only accessible if the Token provided in the URL has read permissions for it:
https://api.tinybird.co/endpoint/t_bdcad2252e794c6573e21e7e?token=<token_with_permissions>
For security, Tinybird automatically generates a read-only Token when sharing a public Endpoint page for the first time. If you don't explicitly use it, your Admin Token never gets exposed.
The Endpoints list page¶
Tinybird also you can render the Endpoints information for a given Token.
https://app.tinybird.co/<provider>/<region>/endpoints?token=<your_token>
Enter the previous URL, with your Token and the provider and region where the Endpoint is published, into the browser to retrieve a list that shows all Endpoints that the Token can read from.
When integrating your Endpoint in your apps, manage dedicated Tokens. The easiest way is creating a Token for each environment, so that you can also track the different requests to your Endpoints by app, and choose which Endpoints are accessible for them.
Once you do that, you can share auto-generated documentation with ease, without compromising your data privacy and security.
Endpoint docs pages include a read Token by default. In the "Share this API endpoint" modal, you can also see public URLs for every Token with read permissions for your Pipe.
Browse your Endpoint docs¶
All Endpoint documentation is compatible with OpenAPI 3.0 and accessible through the API. If you use a Token with permissions for more than one Endpoint, the OpenAPI documentation contains information about all the Endpoints at once.