Getting Started

A service is a program that connects to Requence, receives messages, processes them, and returns results. Services are the building blocks of every task template.

Prepare

Before writing any code, create the service in the Requence UI. Define its input schema, configuration schema, and outputs — including an output schema for each. Requence uses these definitions to validate data at design time and route messages at execution time.

Installation

TypeScript

npm install @requence/service

Python

pip install requence

Authentication

Every service needs an access token to connect to Requence. In the services list view, click the Copy credentials button to copy the access token to your clipboard.

The token is resolved in this order:

TypeScript

1. accessToken option passed to createService()
2. REQUENCE_SERVICE_ACCESS_TOKEN or REQUENCE_ACCESS_TOKEN environment variable
3. requence.service.accessToken or requence.accessToken in package.json

REQUENCE_SERVICE_ACCESS_TOKEN=your-token bun run index.ts

Python

1. access_token key in the config dict passed to Service()
2. REQUENCE_SERVICE_ACCESS_TOKEN or REQUENCE_ACCESS_TOKEN environment variable
3. requence.service_access_token or requence.access_token in pyproject.toml

REQUENCE_SERVICE_ACCESS_TOKEN=your-token python main.py

Your Implementation

TypeScript

import { createService } from '@requence/service'

createService('1.0.0', (ctx) => {
  const input = ctx.input

  return { message: `Hello, ${input.name}!` }
})

Python

from requence.service import Service

def handler(ctx):
    input = ctx.input
    return {"message": f"Hello, {input['name']}!"}

Service("1.0.0", handler)

That’s it. When Requence dispatches a message to this service, the handler runs and the return value is sent back as the service’s result.

Next Steps

Learn about the full Context API available inside your message handler.