POST /generate
This endpoint initiates the generation of an llms.txt file. It supports both “simple” and “enhanced” generation methods, depending on the user’s plan.
Enhanced generation uses AI for higher-quality titles and descriptions. It costs 2x the credits of simple generation.
Request Body
The URL of the website to generate the file for. Must be a valid URL with http/https protocol.
An object containing generation options.
The maximum number of URLs to include. Range: 1-1000.
Whether to include the full text of each page in the output.
Whether to include last modification dates for URLs.
Can be simple or enhanced. Simple uses page metadata, enhanced uses AI for better titles/descriptions.
Cache age in milliseconds. Default is 1 hour for faster scraping.
Response
A unique identifier for the generation job.
The status of the job: queued, processing, completed, or failed.
Progress percentage (0-100).
Human-readable status message.
The URL where the generated llms.txt file can be accessed.
The URL for the full-text version of the llms.txt file (if showFullText was enabled).
The ID of the site created or updated for this generation.
The number of credits deducted for this generation.