Skip to main content

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

string
required
The URL of the website to generate the file for. Must be a valid URL with http/https protocol.
object
An object containing generation options.

Response

string
A unique identifier for the generation job.
string
The status of the job: queued, processing, completed, or failed.
number
Progress percentage (0-100).
string
Human-readable status message.
string
The URL where the generated llms.txt file can be accessed.
string
The URL for the full-text version of the llms.txt file (if showFullText was enabled).
string
The ID of the site created or updated for this generation.
number
The number of credits deducted for this generation.