Skip to main content
GET
Get the status and results of an LLMs.txt generation job
Get the status and results of an LLMs.txt generation job. This endpoint allows you to check if the generation is complete and retrieve the generated content.

Response Structure

The response includes:
  • success: Boolean indicating if the request was successful
  • status: Current status of the generation job:
    • processing: Job is still running
    • completed: Job finished successfully
    • failed: Job encountered an error
  • data: Generated content (when status is completed):
    • llmstxt: The generated LLMs.txt content
    • llmsfulltxt: Full text content (if showFullText was true)
  • expiresAt: ISO timestamp indicating when the results will expire

Status Examples

  1. Processing Status
  2. Completed Status

Error Handling

If the generation job fails or cannot be found, you’ll receive an appropriate error response:

Polling Recommendations

  1. Poll every 2-3 seconds initially
  2. Increase interval if still processing after 30 seconds
  3. Stop polling if status is completed or failed
  4. Implement exponential backoff to avoid rate limits

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

The ID of the LLMs.txt generation job

Response

Successful response

success
boolean
status
enum<string>
Available options:
processing,
completed,
failed
data
object
expiresAt
string<date-time>

When the generated content will expire