Skip to content
rowlab Docs

Render Prompt

POST
/v1/datasets/{dataset_id}/render
curl --request POST \
  --url https://example.com/v1/datasets/example/render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "template": "example", "sql": "SELECT * FROM data", "offset": 0, "limit": 1 }'

Render a prompt template for a page of rows, with warnings and token estimates.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
dataset_id
required
Dataset Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
RenderRequest
object
template
required
Template
string
sql
Sql

The rows to render for: a SELECT over data.

string
default: SELECT * FROM data
offset
Offset

First row to render, counting from 0.

integer
0
limit
Limit
integer
default: 1 >= 1 <= 50

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
RenderResult
object
fields
required
Fields

Everything the template can use.

Array<object>
TemplateField
object
path
required
Path
string
type
required
Type
string
selected_rows
required
Selected Rows

Rows the query returns.

integer
warnings
required
Warnings
Array<string>
rows
required
Rows
Array<object>
RenderedRow
object
row_id
required
Any of:
integer
prompt
required
Prompt
string
tokens
required
Tokens
integer
values
required
Values

The row’s value for each field the template uses.

object
key
additional properties
any
tokens
required
TokenStats
object
sample_size
required
Sample Size
integer
min
required
Min
integer
avg
required
Avg
number
max
required
Max
integer
total_estimate
required
Total Estimate

Estimated tokens for all selected rows.

integer

Example generated

{
  "fields": [
    {
      "path": "example",
      "type": "example"
    }
  ],
  "selected_rows": 1,
  "warnings": [
    "example"
  ],
  "rows": [
    {
      "row_id": 1,
      "prompt": "example",
      "tokens": 1,
      "values": {}
    }
  ],
  "tokens": {
    "sample_size": 1,
    "min": 1,
    "avg": 1,
    "max": 1,
    "total_estimate": 1
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}