Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.trellis.sh/llms.txt

Use this file to discover all available pages before exploring further.

​
Authorization
string
required
Bearer token obtained from the authenticate endpoint.
​
query_id
string
required
Unique identifier of the saved query to retrieve.

​
Response

​
id
string
required
Unique identifier for the saved query.
​
organization_id
string
required
Organization the query belongs to.
​
title
string
required
Display title for the query.
​
description
string
Optional human-readable description of what the query does.
​
prompt
string
required
The natural language instruction passed to the AI agent when this query is invoked.
​
sql
string
The SQL executed when this query runs, or null for prompt-only queries. May contain {{param_name}} placeholders for runtime substitution.
​
keywords
string[]
Optional list of keywords used for automatic semantic matching.
​
parameters
string[]
Names of all {{param_name}} placeholders found in sql, auto-extracted by the server. Supply values for these when invoking the query via the Send Message endpoint.
​
last_updated_by
string
required
Member ID of the user who last modified this query.
​
last_updated_by_name
string
Display name of the user who last modified this query.
​
created_at
string
required
ISO 8601 timestamp when the query was created.
​
updated_at
string
required
ISO 8601 timestamp when the query was last modified.
curl -X GET https://api.trellis.sh/v1/queries/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "organization_id": "org_abc123",
  "title": "Monthly Revenue",
  "description": "Total revenue grouped by month for a given year",
  "prompt": "Show me total revenue by month for {{year}}",
  "sql": "SELECT DATE_TRUNC('month', created_at) AS month, SUM(amount) AS revenue FROM orders WHERE EXTRACT(year FROM created_at) = {{year}} GROUP BY 1 ORDER BY 1",
  "keywords": ["revenue", "monthly", "sales"],
  "parameters": ["year"],
  "last_updated_by": "member_xyz789",
  "last_updated_by_name": "John Doe",
  "created_at": "2025-11-01T10:00:00Z",
  "updated_at": "2025-12-01T15:30:00Z"
}