Tyk Documentation llms.txt · AI Docs Browser · mdream

[llms.txt Tools](https://mdream.dev/llms-txt/tyk-documentation/llms-txt)

# Tyk Documentation llms.txt

tyk.io/llms.txt

[Raw llms.txt](https://tyk.io/docs/llms.txt) [Raw llms-full.txt](https://tyk.io/llms-full.txt)

Copy Markdown [](https://tyk.io/llms.txt)

llms.txt

Docs

Advanced Communication Protocols

Server Sent Events Proxy

Internal Routing

Transformation Use Case: SOAP To REST

Websockets

Manage Apps in Tyk AI Studio

Tutorial: Create an AI CLI App with NodeJS and Tyk AI Studio

AI Portal in Tyk AI Studio

Create an App in Tyk AI Studio

AI Studio (Control Plane) Component

Tyk AI Studio Environment Variables

Tyk AI Studio API

AI Studio User Personas

Analytics & Monitoring in Tyk AI Studio

Tyk AI Studio Architecture

Budget Control in Tyk AI Studio

Manage LLM Call Settings in Tyk AI Studio

Catalogs in Tyk AI Studio

Chat Interface

Manage Chats in Tyk AI Studio

Compliance Events in Tyk AI Studio

Getting Started with Tyk AI Studio

What is AI Studio?

Manage Data Sources in Tyk AI Studio

Install Tyk AI Studio on Kubernetes

Tyk Edge Gateway Environment Variables

Filters and Middleware

Install Tyk AI Studio on Linux

NATS JetStream Configuration for Tyk AI Studio

Installation Options for Tyk AI Studio

LLM Management

Manage Edge Gateway for Tyk AI Studio

Model Prices Management in Tyk AI Studio

Tyk AI Studio Model Router

Notification in Tyk AI Studio

Tyk AI Studio

Tyk AI Studio Plugin Best Practices

Tyk AI Studio Custom Endpoint Plugins

Tyk AI Studio Plugin Deployment Options

Tyk AI Studio Plugin Development Workflow

Tyk AI Studio Edge Gateway Plugins

Tyk AI Studio Plugin Edge to Control Communication

Tyk AI Studio Example Plugins

Tyk AI Studio Plugin Manifests

Object Hooks Plugin in Tyk AI Studio

Tyk AI Studio Plugin Overview

AI Portal UI Plugins

Tyk AI Studio Resource Provider Plugins

Tyk AI Studio Plugin SDK

Tyk AI Studio Service API Reference

AI Studio Agent Plugins

AI Studio UI Plugins

Edge Gateway (Data Plane) Component

Install Tyk AI Studio on Docker

Manage Secrets in Tyk AI Studio

SSO Integration

AI Studio Administrator

Manage Teams in Tyk AI Studio

Telemetry for Tyk AI Studio

Manage Tools in Tyk AI Studio

User Management & RBAC

Manage Users in Tyk AI Studio

MCP Gateway: Core Concepts

MCP Gateway: FAQ

How to block an MCP tool for all consumers

How to build a Grafana dashboard for MCP traffic

How to implement role-based access control for an MCP proxy

How to secure an MCP proxy

How to rate limit individual MCP tools per consumer

Managing MCP proxies using the Dashboard

MCP Gateway Access Logs

MCP API extensions

MCP Gateway Metrics

MCP middleware

MCP Gateway Observability Overview

MCP OAS definition

MCP Gateway: OAuth 2.1 Authentication

MCP Gateway

MCP Gateway Policies

MCP Gateway quickstart

Natural-language interaction with your APIs (API to MCP)

Natural-language interaction with Tyk Dashboard (API to MCP)

Tyk MCP Servers

Natural-language interaction with Tyk Docs (MCP)

AI management

Access Control Overview

Applying Policies

Managing Policies

Access Rights

API Token Generation via Tyk Identity Broker

Key Hashing

Session Lifecycle

Session Metadata

Understanding Sessions

How to install Tyk in Air-Gapped Deployments

API Versioning

Basic Authentication

Authentication Token

Certificate Authentication

Custom Authentication

JWT Authorization

JWT Claim Validation

JWT Quick Start: Securing APIs with Auth0 or Keycloak

JWT Signature Validation

JWT Split Token

Tyk OAuth 2.0 Authorization Server

OAuth 2.0 with an External IdP

Token Exchange

Tyk Automations Tools

Tyk Operator - API Management in Kubernetes

Tyk Sync - Synchronize Tyk Environment With GitHub

Batch Processing

TLS and Certificate Management

Client Authentication and Authorization

Identity Provider Registry

Configure Audit Logs in Tyk Cloud

Collecting Tyk Gateway Logs with OpenTelemetry Collector on Kubernetes

SSO with Proxy Provider

Customizing Error Responses

Manage the Tyk Dashboard

Universal Data Graph

Enable and View Audit Logs in Tyk Dashboard

Tyk Streams – Manage Event-Driven APIs

FIPS Implementation

Configuring Tyk Gateway

Managing Tyk Classic API Definition

Working with Tyk OAS APIs

Tyk Classic API Definition

Tyk OAS

Gateway Events

GraphQL

GraphQL Schema Types

Implementing TLS with Tyk

Application and Access Logs

OpenTelemetry Metrics Configuration in Tyk Gateway

API Observability

API Creation Methods

Using Tyk In Distributed Environments

Custom Metrics in Tyk Gateway

Default Tyk Gateway Metrics Reference

Migrating from Tyk Classic APIs

Manage Multiple Environments

OpenTelemetry in Tyk Gateway: Tracing, Metrics, and Logs

Get Started with Tyk Observability

Tyk Gateway Observability Best Practices

Tyk Gateway Observability Playbook

Performance Monitoring

Custom Plugins Advance Configuration

Golang Plugins

Javascript Plugins

Custom Plugins

Plugin Types

Rich Plugins

Understanding Policies

Rate Limiting

Request Quotas

Request Throttling

Caching Responses

Routing Traffic

Security Best Practices

Security Features

SSO with LDAP

SSO with Social Identity Providers

Tyk Streams Configuration

Tyk Streams End-to-End Example

Tyk Sync Quick Start Guide

Automate API Configuration Management with Tyk Sync

Distributed Tracing in Tyk Gateway

Send Tyk Traces to Datadog

Send Tyk Traces to Dynatrace

Send Tyk Traces to Elasticsearch

Send Tyk Traces to Jaeger

Send Tyk Traces to New Relic

Transform Traffic by using Tyk Middleware

Allow List

Block List

Do Not Track

Go Templates

Ignore Authentication

JQ Transforms

Request Termination

Request Body

Request Context Variables

Request Headers

Request Method

Request Size Limits

Request Validation

Response Body

Response Headers

Virtual Endpoints

Troubleshooting and Debugging

Tyk Pump - Export Metrics and Logs to Persistent Datastore

Upstream Authentication

Upstream Authentication using Auth Token

Upstream Authentication using Basic Auth

Upstream Authentication using Mutual TLS

Upstream Authentication using OAuth

Upstream Authentication using Request Signing

User management with Tyk Dashboard

Approve an access request

Delete an access request

Get an access request's data

List all access requests

Reject an access request

Add/Delete/Update additional permission.

List additional permissions.

Analytics of API Key.

Analytics of Oauth Client ID.

Average MCP Proxy usage.

Get app interactions over time

Get budget usage for a specific app

Get chat interactions for a specific chat

Get chat records per day

Get chat records per user

Get cost analysis

Get current monthly budget usage for apps and LLMs

Get most used LLM models

Get proxy logs for a specific app

Get proxy logs for a specific LLM

Get token usage and cost data with flexible filtering

Get token usage and cost for a specific app

Get token usage for a specific app

Get token usage per app

Get token usage per user

Get tool calls per day

Get tool operations usage over time for a specific tool

Get tool usage statistics

Get total cost per vendor and model

Get unique users per day

Get usage statistics for a specific model

Get usage statistics for a specific vendor

MCP activity per API key.

MCP primitive activity.

MCP primitive errors.

Add a new specification to this Documentation Product

Delete a specification

Delete GraphQL schema file of an API

Delete OAS file of a Specification

Delete OAS file of an API

Delete Specification with GraphQL schema

Download GraphQL schema file of a Specification

Download GraphQL schema file of an API

Download OAS file of a Specification

Download OAS file of an API

Get description of a Specification

Get description of an API

List all APIs included in this API Product

List all Specification details included in this Documentation Product

Update description of a Specification

Update description of an API

Update OAS file of an API

Upload GraphQL schema file of a Specification

Upload GraphQL schema file of an API

Upload GraphQL SDL for Documentation Product

Upload OAS file of a Specification

Create an API

Create API Definition

Delete a single API by ID

Deleting an API definition with ID.

Get a list of example API definitions.

Get a single API by ID

Get API access rights (users and userGroups)

Get API Categories

Get API definition with it's ID.

Get API Groups.

Get API URLs

Get details of a single example API definition.

Get List of APIs

Invalidate cache for given API ID.

Listing versions of an API.

Search List of APIs

Update API access rights (users and userGroups)

Update API Definition

Updating an API definition with its ID.

Create a Custom Credential

Create a new access request for this application

Create a new developer application

Delete a credential from an access request

Delete a Custom Credential

Delete an access request

Delete an application

Get a credential by its ID

Get a Custom Credential

Get an access request's data

Get an application's data

List all access requests for this application

List all developer application that exist in the portal

List credentials for an access request

List Custom Credentials

Rotate credentials

Update a Custom Credential

Update an application

Activate app credential

Add a tool to an app

Count all apps

Count apps by user ID

Create a new app

Deactivate app credential

Delete an app

Get an app by ID

Get app by name

Get apps by user ID

Get tools for an app

List all apps

Remove a tool from an app

Reset app budget

Search apps

Update an app

Create an asset

Delete an asset by ID.

Retrieve an asset.

Retrieve list of assets.

Update an asset by ID.

List audit logs

Retrieve single audit log

Create a nonce token for SSO authentication

Forgot password

Get current user with entitlements

Handle SSO authentication with a nonce token

Handle the callback from an identity provider

Handle the SAML metadata request for an identity provider

Handle TIB authentication

Initiate authentication

Initiate authentication (POST)

Login user

Logout user

OAuth / SAML callback

OAuth / SAML callback (POST)

Register user

Resend verification email

Reset password

SAML SP metadata

Validate reset token

Verify email

Create a Basic Auth User.

Run batch request.

Get branding settings

Get custom favicon

Get custom logo

Reset branding to defaults

Update branding settings

Upload favicon

Upload logo

Invalidate cache.

Add a new audience to this catalogue

List all audiences for this catalogue

List audiences for this catalogue

Remove an audience from a catalog

Add an LLM to a catalogue

Add LLM to catalogue

Create a new catalogue

Create a new catalogue

Delete a catalogue

Delete catalogue

Get a catalogue

Get a catalogue by ID

Get catalogue by ID

List all catalogues

List catalogue LLMs

List catalogues

List LLMs in a catalogue

Remove an LLM from a catalogue

Remove LLM from catalogue

Search catalogues

Search catalogues by name

Search catalogues by name

Search catalogues by name stub

Update a catalogue

Update catalogue

Create a certificate in Tyk org cert store.

Delete Certificate.

Delete Certificate dependencies.

Get Certificate Dependencies.

Get single certificate with ID.

List all certificates details.

List APIs lined to a certificate

List Certificates.

Add a certificate.

Delete certificate.

List certificates.

Return one certificate or list multiple certificates in the Tyk Gateway given a comma separated list of cert IDs.

Create a new chat history record

Delete a chat history record

Get a chat history record

List chat history records

Update the name of a chat history record

Create a new app for the authenticated user

Delete an app owned by the authenticated user

Get accessible data sources for the authenticated user

Get accessible LLMs for the authenticated user

Get accessible tools for the authenticated user

Get apps for the authenticated user

Get chat history records for a user

Get datasources in a data catalogue

Get default tools and datasource for a specific chat

Get details of a specific app for the authenticated user

Get LLMs in a catalogue

Get messages for a session

Check if compliance features are available

Export compliance data

Get access issues

Get app risk profile

Get budget alerts

Get compliance errors

Get compliance summary

Get high risk apps

Get individual violation records

Get policy violations

Retrieve current configuration status

Retrieve environment variables

Activate a credential

Create a new credential

Deactivate a credential

Delete a credential

Get a credential by ID

Get a credential by Key ID

List active credentials

List all credentials

Update a credential

Create a new custom attribute

Delete a custom attribute

Get a custom attribute

Get a default attribute

Get an extended model detail

List all custom attributes for a particular extended model

List all default attributes for a particular extended model

List all extended models

Update a custom attribute

Update default attribute

Reloads dashboard urls

Add a datasource to a data catalogue

Add a tag to a data catalogue

Add datasource to data catalogue

Add tag to data catalogue

Create a new data catalogue

Create a new data catalogue

Delete a data catalogue

Delete data catalogue

Get a data catalogue by ID

Get data catalogue by ID

Get data catalogues by datasource

Get data catalogues by datasource

Get data catalogues by tag

Get data catalogues by tag

List all data catalogues

List data catalogues

Remove a datasource from a data catalogue

Remove a tag from a data catalogue

Remove datasource from data catalogue

Remove tag from data catalogue

Search data catalogues

Search data catalogues

Update a data catalogue

Update data catalogue

Retrieve information of all the connected data plane nodes.

Add FileStore to Datasource

Clone a datasource

Create a new datasource

Delete a datasource

Get a datasource by ID

Get datasources by tag

List all datasources

Process file embeddings for a datasource

Remove FileStore from Datasource

Search datasources

Update a datasource

CPU Profiling data

pprof data

Test a Tyk Classic or Tyk OAS API definition.

Delete edge instance

Get edge instance by ID

Get edge reload operations

List edge instances

Reload all edge gateways

Trigger edge reload

Download export file (Enterprise)

Get export status (Enterprise)

Start a proxy log export (Enterprise)

Create a new filestore entry

Delete a filestore entry

Get a filestore entry by ID

Get all filestore entries

Search filestore entries

Update a filestore entry

Create a new filter

Delete a filter

Get a filter by ID

List all filters

Test a filter script

Update a filter

Add a catalogue to a group

Add a data catalogue to a group

Add a tool catalogue to a group

Add a user to a group

Add data catalogue to group

Add LLM catalogue to group

Add tool catalogue to group

Add user to group

Create a new group

Create a new group

Delete a group

Delete group

Get a group by ID

Get group by ID

Get groups for a user

Get user's groups

List all groups

List catalogues in a group

List data catalogues in a group

List group data catalogues

List group LLM catalogues

List group tool catalogues

List group users

List groups

List tool catalogues in a group

List users in a group

Remove a catalogue from a group

Remove a data catalogue from a group

Remove a tool catalogue from a group

Remove a user from a group

Remove data catalogue from group

Remove LLM catalogue from group

Remove tool catalogue from group

Remove user from group

Update a group

Update group

Update group catalogues

Update group catalogues

Update group users

Update group users

Check the health of the Tyk Gateway.

Check liveness status

Check system readiness status

Health check

Hot-reload a group of Tyk nodes.

Hot-reload a single node.

Import APIs

Import organisations

Import Policies

Invalidate cache for given API ID.

Invalidate JWK cache for all APIs

Create a key.

Create a key.

Create custom key.

Create custom key / Import key

Delete a key.

Delete key.

Delete key with API ID and key ID.

Get a key with ID.

Get key Details.

Get key details with API ID and key ID.

List All the keys.

List All the Keys info.

List keys.

List keys by API.

Search keys by API.

Set policies for a hashed key.

This will validate a key definition.

Update key.

With API ID and key ID.

Create new LLM settings

Delete LLM settings

Get LLM settings by ID

List all LLM settings

Search LLM settings by model name

Update LLM settings

Create a new LLM

Delete an LLM

Get an LLM by ID

Get LLM plugin configuration

Get LLM plugins

Get LLMs by maximum privacy score

Get LLMs by minimum privacy score

Get LLMs by privacy score range

List all LLMs

Search LLMs by name

Update an LLM

Update LLM plugin configuration

Update LLM plugins

Create an MCP Proxy definition.

Delete an MCP Proxy definition.

Get an MCP Proxy definition.

List MCP Proxy definitions.

Update an MCP Proxy definition.

Migrate APIs from Tyk Classic to Tyk OAS format.

Create a new model price

Delete a model price

Get a model price by ID

Get all model prices

Get model prices by vendor

Update a model price

Update a model price and recalculate historical costs

Update a model price and recalculate historical costs

Create a new model router

Delete a model router

Get a model router by ID

List all model routers

Toggle model router active status

Update a model router

Get namespace edges

Get reload operation status

List namespaces

Reload namespace

Convert child API to base API.

Create OAS API.

Delete OAS API.

Dry Run OAS.

Export OAS API.

Get OAS API details.

Get OAS API server URLs.

Get OAS API's Categories.

Import OAS.

List OAS API versions.

Patch a single OAS API by ID.

Update OAS API.

Update OAS API categories.

Create a new OAuth2.0 client.

Create new OAuth client

Delete OAuth client.

Get API IDs for APIS that use the specified client_id(appID) for OAuth

Get OAuth client

Get OAuth Consent Details

Get single OAuth client details.

Invalidate OAuth refresh token

List OAuth client tokens.

List OAuth clients.

List tokens for a provided API ID and OAuth-client ID

OAuth Authorization Endpoint

OAuth Authorization Server Metadata

OAuth Token Endpoint

Purge lapsed OAuth tokens

Purge OAuth tokens.

Register OAuth Client

Revoke all client's tokens

revoke token

Rotate the oath client secret

Submit OAuth Consent

Update OAuth metadata,redirecturi,description and Policy ID

Create a new client type of an OAuth2.0 Identity Provider

Delete a client type for an OAuth2.0 Identity Provider

Delete an OAuth2.0 Identity Provider

Get a client type's data

Get an Identity Provider's data

List all client types for an OAuth2.0 Identity Provider

List all OAuth2.0 Identity providers that are registered in the portal

Register a new OAuth2.0 Identity Provider in the portal

Update a client type for an Identity Provider

Update an OAuth2.0 Identity Provider

List OPA rules.

Update OPA rules.

Retrieve notifications

Create an organisation key

Delete Key

Get an Organisation Key

List Organisation Keys

Update Organisation Key

Create a new developer organisation

Create an Organisation

Delete an organisation

Generate Portals

Get an organisation

List all developer organisations

List all organisations

Retrieve a single organisation

Update an organisation

Update organisation details

Create a new content block for a page

Create a new content page

Delete a page

Delete content blocks from this page

Get a content block

Get a page

List all content blocks which are displayed on this page

List all content pages

Update a content block

Update a page

Create a new plan

Delete a plan

Get a plan

List all plans

Update a plan

Approve or deny plugin service scopes

Call plugin RPC method

Cleanup orphaned UI registry entries

Clear plugin data

Create plugin

Create plugin from OCI artifact

Delete plugin

Get AI Studio plugins with manifests

Get plugin

Get plugin status

Get plugin workflow status

Get plugins by type

Get sidebar menu items

Get UI registry

List cached OCI plugins

List loaded plugins

List plugins

Load plugin UI

Parse plugin manifest

Refresh OCI plugin

Reload AI Studio plugin

Serve plugin asset

Test plugin

Unload plugin UI

Update plugin

Validate plugin command and load metadata

Create a policy.

Create policy definition.

Delete a policy.

Delete a single policy by ID.

Get a policy.

Get a single policy by ID.

Get list portal policies.

List policies.

Search list of policies.

Update a policy.

Update policy definition.

Get app interactions analytics for portal user

Get app usage analytics for portal user

Get the portal config

Attach a category to a post

Attach a tag to a post

Create a new post

Delete a post

Detach a category from a post

Detach a tag from a post

Get a post by ID

List all posts

List categories for a post

List tags for a post

Update a post

Attach a client type to this API Product

Attach a tag to this API Product

Create a new product

Delete a product

Delete a tag from this API Product

Delete the logo/product page image for this API Product

Delete the preview/catalogue page image for this API Product

Detach a client type from this API Product

Get a client type attached to this API Product

Get a product

Get a tag from this API Product

Get the logo/product page image for this API Product

Get the preview/catalogue page image for this API Product

List all client types for this API Product

List all products

List all tags for this API Product

Update a product

Upload a logo/product page image for this API Product

Upload a preview/catalogue page image for this API Product

Create a profile

Delete a profile

Get a profile

List all profiles

Update a profile

Configure provider credentials

Create a new API Provider

Delete an API Provider

Get an API Provider configuration

Get API specifications from provider

Get import steps

Import OpenAPI spec

List all API Providers

List available OpenAPI providers

Synchronize API Products and plans with an API Provider

Update Provider

Proxy API request

Get OAS schema.

Get all API definition schemas.

Get API definition OAS schema.

Get API definition OAS schema.

Get API definition Streams OAS schema.

Get MCP Proxy definition schema.

Create a new secret

Delete a secret

Get a secret by ID

List all secrets

Update a secret

Generate authentication token

Create a new SSO profile

Delete an SSO profile

Get an SSO profile

Get an SSO profile by ID

Get the profile used in the login page

List all SSO profiles

Set profile use in login page

Update an SSO profile

Create Streams API.

Delete Streams API.

Get Streams API details.

Patch a single Streams API by ID.

Update Streams API.

Get sync audit log

Get sync status for namespace

Get sync status summary

Get system feature set

Get system usage info.

Create a new tag

Delete a tag

Get a tag

Get a tag by ID

List all tags

Search tags by name

Update a tag

Create a new team for an organisation

Delete a team from an organisation

Get teams for an organisation

List all teams for an organisation

Update a team for an organisation

Activate a theme

Download a theme

Get a theme

List all themes

Soft delete a theme

Upload a theme

Add a tag to a tool catalogue

Add a tool to a tool catalogue

Add tag to tool catalogue

Add tool to tool catalogue

Create a new tool catalogue

Create a new tool catalogue

Delete a tool catalogue

Delete tool catalogue

Get a tool catalogue by ID

Get tags in a tool catalogue

Get tool catalogue by ID

Get tool catalogue tags

Get tool documentation

Get tools in a tool catalogue

Get tools in a tool catalogue (secure version for portal users)

Get user apps for a tool

List all tool catalogues

List tool catalogue tools

List tool catalogue tools (secure)

List tool catalogues

Remove a tag from a tool catalogue

Remove a tool from a tool catalogue

Remove tag from tool catalogue

Remove tool from tool catalogue

Search tool catalogues

Search tool catalogues

Update a tool catalogue

Update tool catalogue

Add dependency to tool

Add FileStore to Tool

Add Filter to Tool

Add operation to tool

Call Tool Operation

Create a new tool

Delete a tool

Get a tool by ID

Get all tools

Get tool dependencies

Get tool documentation by ID

Get Tool FileStores

Get Tool Filters

Get tool operations

Get tools by type

Get user apps that have access to a tool

List Tool Operations from OpenAPI Spec

Remove dependency from tool

Remove FileStore from Tool

Remove Filter from Tool

Remove operation from tool

Search tools

Set tool dependencies

Set Tool FileStores

Set Tool Filters

Update a tool

Change order of tutorial pages

Create a new tutorial page for this API Product

Delete a tutorial page from this API Product

Get a tutorial page

List all tutorials for this API Product

Update a tutorial page

Create an API with Tyk OAS format.

Deleting a Tyk OAS API.

Download a Tyk OAS format API.

Download all Tyk OAS format APIs.

Get a Tyk OAS API definition.

Import an API in Tyk OAS format.

List all APIs in Tyk OAS API format.

Listing versions of a Tyk OAS API.

Patch API in Tyk OAS format.

Update a Tyk OAS API definition.

Create user group.

Delete user group.

Get user group details.

List user groups.

Update user group.

Add user.

Allow password reset for a User

Create a new user

Create a user

Delete a custom attribute

Delete a user

Disallow password reset for a User

Get a user

Get a user by ID

Get a user custom attribute

Get current user.

Get extended custom attributes for user

Get user accessible catalogues

Get user details

List all users

List all users with optional search filter

List users

Reset user Dashboard API access credentials.

Revoke user.

Roll API Key

Search user with email.

Search Users(Deprecated)

Set user password.

Skip user quick start wizard

Update a user

Update a user custom attribute

Update user.

Update user details

Get available embedders

Get available LLM drivers

Get available vector stores

Add a new header to a webhook

Create a new webhook

Create a webhook.

Delete a header by ID for a specific webhook

Delete a webhook by ID

Delete web hook.

Get a header by ID for a specific webhook

Get a webhook by ID

Get single webhook.

List all headers for a webhook

List all webhooks

List webhooks.

Update a header by ID for a specific webhook

Update a webhook by ID

Update Webhook

Tyk API Management Deployment Options

Installation Options for Tyk Gateway

Sign Requests with HMAC

JSON Web Token (JWT) Authentication

Combine Authentication Methods

Open (No Authentication)

External Services Configuration

Outbound Email Configuration

Tyk Dashboard Admin API

Container Runtimes

Quick Start: Tyk Open Source Gateway

Community Support

Contributing to Tyk documentation

Contributing Guides

Tyk Deprecation and EOL Policy

Inclusive Naming

Frequently Asked Questions

Tyk AI Studio Release Notes

Archived Releases

## What is Tyk Documentation's llms.txt?

Tyk Documentation publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what Tyk Documentation offers and where to find details.

Pass

Spec

1

Sections

956

Links

97.6 KB

Size

~25.0k

Tokens

Sections: Docs

## Add Tyk Documentation Docs to Your AI Assistant

Select your tool to see how to add Tyk Documentation's llms.txt as a documentation source.

Cursor

 Windsurf

 Claude Code

 ChatGPT

 Zed

 Copilot

1. 1

   Open any chat or composer panel
2. 2

   Type @Docs and select "Add new doc"
3. 3

   Paste the URL: https://tyk.io/llms.txt
4. 4

   Wait for the green dot (indexing complete)
5. 5

   Reference @Docs in chat when asking about Tyk Documentation

Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too.

## Spec Compliance 5 notes

## Frequently Asked Questions

Where is Tyk Documentation's llms.txt file?

Tyk Documentation publishes its llms.txt at https://tyk.io/llms.txt. This file provides a structured, markdown-formatted index of Tyk Documentation's documentation that AI systems can consume to understand the project's APIs, guides, and references.

How do I use Tyk Documentation's llms.txt with AI coding assistants?

Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of Tyk Documentation's documentation so it can provide better code suggestions and answers about Tyk Documentation.

What does Tyk Documentation's llms.txt contain?

Tyk Documentation's llms.txt contains 1 sections and 956 documentation links in 97.6 KB (~25.0k tokens). Key sections include Docs.

How many tokens does Tyk Documentation's llms.txt use?

The concise llms.txt index is approximately 25.0k tokens (97.6 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline.

Can I generate an llms.txt for my own project?

Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator.

## Browse More llms.txt Files

[ElevenLabs Documentation](https://mdream.dev/llms-txt/tyk-documentation/llms-txt/elevenlabs-documentation) [Kirby CMS Docs The official Kirby CMS documentation for Kirby CMS, covering Guides, Reference, Cookbook and Quicktips.](https://mdream.dev/llms-txt/tyk-documentation/llms-txt/kirby-cms-docs) [Junction](https://mdream.dev/llms-txt/tyk-documentation/llms-txt/junction) [Dynamic Documentation**Agent navigation guide:** Use the Table of Contents to identify the](https://mdream.dev/llms-txt/tyk-documentation/llms-txt/dynamic-documentation) [Mangopay docs](https://mdream.dev/llms-txt/tyk-documentation/llms-txt/mangopay-docs) [Saleor Commerce The commerce engine for modern software development teams.](https://mdream.dev/llms-txt/tyk-documentation/llms-txt/saleor-commerce) [Meilisearch Documentation](https://mdream.dev/llms-txt/tyk-documentation/llms-txt/meilisearch-documentation) [Spree Commerce documentation](https://mdream.dev/llms-txt/tyk-documentation/llms-txt/spree-commerce-documentation)

[View all 99 projects ](https://mdream.dev/llms-txt/tyk-documentation/llms-txt)

## Related Tools

[<h3>llms.txt Generator</h3>Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/tyk-documentation/tools/llms-txt/generator) [<h3>llms.txt Validator</h3>Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/tyk-documentation/tools/llms-txt/validator)

© 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license)

[GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)