API Reference

Complete reference of all Xano SDK methods organized by category.

Core Methods

XanoScript.create

Create a new endpoint builder.

const endpoint = XanoScript.create('products/list', 'GET')

.description

Add endpoint description.

.description('List all products with pagination')

.requiresAuth

Require authentication for this endpoint.

.requiresAuth('users')

Input Methods

.input

Define an input parameter.

.input('email', 'email', { required: true })
.input('page', 'int', { default: 1 })
.input('data', 'object')

Database Methods

.dbGet

Get a single record by field value.

.dbGet('"users"', { id: '$input.user_id' }, 'user')

.dbQuery

Query multiple records with advanced options.

.dbQuery('"products"', {
  search: '$input.search',
  filters: { status: 'active' },
  pagination: { page: '$input.page', per_page: 20 },
  sort: { field: 'created_at', direction: 'desc' }
}, 'results')

.dbAdd

Create a new record.

.dbAdd('"users"', {
  email: '$input.email',
  first_name: '$input.first_name',
  created_at: 'now'
}, 'new_user')

.dbEdit

Update existing records.

.dbEdit('"users"', 
  { id: '$auth.id' },
  { last_login: 'now' },
  'updated_user'
)

.dbDelete

Delete records.

.dbDelete('"sessions"', { user_id: '$auth.id' }, 'deleted_count')

.dbBulkAdd

Add multiple records in one operation.

.dbBulkAdd('"products"', '$input.products', {
  allowIdField: true
}, 'created')

.dbBulkUpdate

Update multiple records.

.dbBulkUpdate('"products"', '$input.updates', 'updated_count')

.dbBulkDelete

Delete multiple records matching a condition.

.dbBulkDelete('"sessions"', 'expires_at < now()', 'deleted_count')

Security Methods

.hashPassword

Hash a password securely.

.hashPassword('$input.password', 'password_hash')

.verifyPassword

Verify a password against a hash.

.verifyPassword('$input.password', '$user.password', 'is_valid')

.createToken

Generate a JWT token.

.createToken({
  user_id: '$user.id',
  role: '$user.role'
}, 86400, 'auth_token')

.verifyToken

Verify a JWT token.

.verifyToken('$input.token', 'token_data')

.createUuid

Generate a unique identifier.

.createUuid('transaction_id')

.randomNumber

Generate a random number.

.randomNumber(100000, 999999, 'verification_code')

API Methods

.apiRequest

Make an HTTP request to an external API.

.apiRequest(
  'https://api.example.com/data',
  'POST',
  {
    headers: [
      { key: 'Authorization', value: 'Bearer $api_key' },
      { key: 'Content-Type', value: 'application/json' }
    ],
    body: { data: '$input.data' }
  },
  'api_response'
)

.graphqlRequest

Make a GraphQL query.

.graphqlRequest(
  'https://api.example.com/graphql',
  'query GetUser($id: ID!) { user(id: $id) { name email } }',
  { id: '$input.user_id' },
  [{ key: 'Authorization', value: 'Bearer $token' }],
  'graphql_response'
)

.lambda

Execute JavaScript code.

.lambda(`
  const total = data.items.reduce((sum, item) => sum + item.price, 0);
  return { total: total };
`, 10, 'calculation')

Storage Methods

.createImage

Upload and store an image.

.createImage(
  'public',
  '$input.photo',
  'profiles/$auth.id.jpg',
  'uploaded_image',
  {
    resize: { width: 800, height: 600, fit: 'cover' },
    quality: 85
  }
)

.createVideo

Upload and store a video.

.createVideo(
  'private',
  '$input.video',
  'videos/$auth.id.mp4',
  'uploaded_video'
)

.createAttachment

Upload and store a document or file.

.createAttachment(
  'private',
  '$input.document',
  'documents/$auth.id/$timestamp.pdf',
  'uploaded_doc'
)

.deleteFile

Delete a stored file.

.deleteFile('$user.profile_photo_id', 'deleted')

Control Flow Methods

.conditional

Start a conditional block.

.conditional('$user.role == "admin"')
  .then()
  .var('has_access', 'bool', true)
.else()
  .var('has_access', 'bool', false)
.endConditional()

.precondition

Validate a condition and stop execution if false.

.precondition('$user != null', 'User not found')
.precondition('$input.amount > 0', 'Amount must be positive')

.forEach

Loop through an array.

.forEach('$input.items', '$item')
  .var('total', 'int', '$total + $item.price')
.endForEach()

.for

Execute a loop a specific number of times.

.for('10', '$i')
  .var('squared', 'int', '$i * $i')
.endFor()

.while

Execute a loop while a condition is true.

.while('$counter < 10')
  .var('counter', 'int', '$counter + 1')
.endWhile()

Variable Methods

.var

Declare and assign a variable.

.var('total', 'decimal', '$price * $quantity')
.var('is_valid', 'bool', '$user != null && $user.active')
.var('config', 'object', { timeout: 5000, retries: 3 })

.filter

Apply text transformations.

.filter('$input.email', ['trim', 'lower'], 'clean_email')
.filter('$input.name', ['trim', 'capitalize'], 'formatted_name')

Available filters: trim, lower, upper, capitalize, replace, substr

.arrayPush

Add an item to an array.

.var('results', 'array', [])
.arrayPush('$results', '$item')

Response Methods

.response

Set the endpoint response.

.response({
  user: '$user',
  token: '$auth_token',
  message: 'Login successful'
})

.return

Early return from a conditional block.

.conditional('$user == null')
  .then()
  .return({ error: 'Not found' })
.endConditional()

Build Method

.build

Build the endpoint and generate XanoScript.

Returns an object with:

• script - Generated XanoScript code
• metadata - Endpoint metadata

const endpoint = XanoScript.create('users/list', 'GET')
  .description('List users')
  .input('page', 'int', { default: 1 })
  .dbQuery('"users"', {
    pagination: { page: '$input.page', per_page: 20 }
  })
  .response({ users: '$results.items' })
  .build();
 
console.log(endpoint.script);

Next Steps

• Database Operations - Learn database methods in depth
• API Integration - Master external API calls
• Security & Auth - Implement authentication
• Storage & Files - Handle file uploads
• Recipes - See complete examples