n8n Documentation

Technical Documentation: n8n-io/n8n

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (README.md) Copy Section

n8n – The Platform for AI Agents and Workflow Automation

Fair-code platform to build and deploy AI agents and workflows. Combine a visual canvas with custom code, run it self-hosted or in the cloud, and connect to 1500+ integrations. AI automation you can trust with real work, from prototype to production.

Key Capabilities Copy Chapter

• AI-Native Automation Platform: Build and operationalize AI workflows and multi-step agents using your own data, models, and tools
• Model Flexibility, No Lock-In: Connect to OpenAI, Anthropic, Google, or open-source models and switch providers without changing your architecture
• From Prototype to Production: Design multi-step AI workflows with logic, tool use, human approvals, and full observability
• Code When You Need It: Combine visual building with JavaScript, Python, and npm packages for advanced AI workflows
• Enterprise-Ready AI: Self-host or deploy securely with role-based access, audit trails, and support for sensitive data
• Leverage What Already Exists: 1500+ integrations and 9,000+ workflow templates to connect AI with your existing systems

Quick Start Copy Chapter

Try n8n instantly with our install script (requires Docker):

curl -fsSL https://get.n8n.io | sh

Or deploy manually with Docker:

docker volume create n8n_data
docker run -it --rm --name n8n -p 5678:5678 -v n8n_data:/home/node/.n8n docker.n8n.io/n8nio/n8n

Access the editor at http://localhost:5678

Resources Copy Chapter

• 📚 Documentation
• 🔧 1500+ Integrations
• 💡 Example Workflows
• 🤖 AI & LangChain Guide
• 👥 Community Forum
• 📖 Community Tutorials

Support Copy Chapter

Need help? Our community forum is the place to get support and connect with other users:
community.n8n.io

License Copy Chapter

n8n is fair-code distributed under the Sustainable Use License and n8n Enterprise License.

• Source Available: Always visible source code
• Self-Hostable: Deploy anywhere
• Extensible: Add your own nodes and functionality

Enterprise Licenses available for additional features and support.

Additional information about the license model can be found in the docs.

Contributing Copy Chapter

Found a bug 🐛 or have a feature idea ✨? Check our Contributing Guide for a setup guide & best practices.

Join the Team Copy Chapter

Want to shape the future of automation? Check out our job posts and join our team!

What does n8n mean? Copy Chapter

Short answer: It means "nodemation" and is pronounced as n-eight-n.

Long answer: "I get that question quite often (more often than I expected) so I decided it is probably best to answer it here. While looking for a good name for the project with a free domain I realized very quickly that all the good ones I could think of were already taken. So, in the end, I chose nodemation. 'node-' in the sense that it uses a Node-View and that it uses Node.js and '-mation' for 'automation' which is what the project is supposed to help with. However, I did not like how long the name was and I could not imagine writing something that long every time in the CLI. That is when I then ended up on 'n8n'." - Jan Oberhauser, Founder and CEO, n8n.io

Adr README (`docs/adr/README.md`) Copy Section

Architecture Decision Records

An Architecture Decision Record (ADR) is a short, dated record of one
important technical decision: the context, the decision, the alternatives,
and the consequences.

The company process is defined in the Notion page
Engineering Technical Decisions and its sub-page
Architecture Decision Records.
This README applies that process to this repository and records the
conventions that the reviews of the first records settled.

When to write an ADR Copy Chapter

Write an ADR when the reason for a decision can matter in the future. The
test from the company process: if an engineer challenges this choice in 12
months, will the original context and alternatives help them?

Write one record for each decision. The test: can this decision be reversed on
its own? If yes, it gets its own file. Do not put two independent decisions
into one record.

Do not write an ADR for an implementation detail, a refactor, or a choice that
follows an existing decision.

Location Copy Chapter

Store a record in the package where the implementation lives, in its
docs/adr/ directory. For example, a record about engine v2 goes in
packages/@n8n/engine/docs/adr/. A record that concerns the whole repository
goes in the root docs/adr/, next to this README. CI rejects any other
location.

File name Copy Chapter

The file name follows from the title and the date:

ADR-YYYYMMDD-<title in kebab-case>.md

The title is the H1 of the record. It states the decision, not the topic:
"Use PostgreSQL advisory locks", not "Database locking". The date is the date
of the decision, and it matches the Date field. CI checks both.

Do not rename a record after it is merged. Links depend on the file name.
Refer to a record by its full file name, for example
ADR-20260828-obtain-trigger-output-before-creating-the-execution, not by a
number. CI checks that every record ID a record mentions names a file.

Template Copy Chapter

Copy docs/ADR_TEMPLATE.md from the repository root.
It is the one template, and CI checks every record against its structure.

The header has three required fields, Date, Status, and Decision Owner,
in that order, and three optional fields, Source, Supersedes, and
Superseded by. Omit an optional field that has no value. Source names
where the decision came from: a ticket, an RFC, or an incident. The body
names none of these. The RFC field under Links holds the link to the RFC.

Status Copy Chapter

Use one of three values:

• Active. The decision stands.
• Superseded. A newer record replaced the decision. Link to it in
  Superseded by.
• Deprecated. The decision no longer applies and no record replaces it.

There is no Draft or Proposed status. The pull request holds that state while
the record is written and checked.

The status says whether the decision stands. It does not say whether the code
exists. Implementation progress belongs nowhere in the record.

What goes where Copy Chapter

Context. The problem and the constraints. State the world as it is, in
the present tense: "In engine v1, putExecutionToWait sleeps in the process
for a time wait under 65 seconds." Do not date a fact ("at the date of this
record"), do not narrate history ("core has since decided"), and do not phase
work ("the shim's part lands later"). The record is dated once, in its header.
Aim for fewer than 150 words.

Decision. What we decided, and the main reason. State the behaviour the
decision guarantees, in the present tense and the active voice: "A wait fires
at its deadline and not before it. A wait fires once, however many replicas
run." Describe the mechanism only when the mechanism is the decision. A sweep
that sleeps until the next deadline is how the engine fires waits today; the
guarantee is what the record decides. Do not write implementation state here.
A sentence such as "the engine does not do this yet" goes stale exactly where
a reader takes the text as the current contract.

Alternatives Considered. Each option we did not select, and why. Lead with
the reason: "We rejected it for two reasons." An option that reads as an equal
choice leaves the reader to guess why it lost. Use the conditional mood for
what an alternative would do: "This option would need a column." The
indicative mood ("this option needs a column") reads as a description of
shipped code.

Consequences. What follows from the decision: benefits, trade-offs,
constraints, and operational effects. A constraint on the mechanism belongs
here: "One statement must read the step rows and write the status." How the
code meets the constraint today, and the order in which the work lands, do
not. This is the one section that may grow after the record is merged. A
consequence that the team learned later belongs here. A changed decision does
not.

Links. Exactly three fields, each on one line: RFC, Documentation, and
Related ADRs. Write - when a field has no value. Name related records by
full file name. There is no Tickets field.

Changing a decision Copy Chapter

A merged record is history. Do not edit its Context, Decision, or Alternatives
to reflect a later change. Write a new record instead.

Therefore a change to the Context, the Decision, or the Alternatives rides the
pull request that merges the record. In a stack, the change belongs in the
first pull request that carries the record, not in the follow-up that
implements it. A decision can merge before its code. That is normal, and not a
reason to move or edit the record.

When a new decision replaces an old one:

1. Write a new record. Explain the new context.
2. Set Supersedes in the new record and Superseded by in the old one.
3. Set the old record's status to Superseded.

When a decision no longer applies and nothing replaces it, set its status to
Deprecated.

Style Copy Chapter

• Write in ASD-STE100 Simplified Technical English, as AGENTS.md requires:
  short sentences, the active voice, one idea for each sentence.
• Wrap paragraph lines at 100 columns. CI enforces it. The Links fields
  are exempt and stay on one line each.
• Do not reference a ticket in the body. Every sentence must stand without
  the ID: "Send-and-wait nodes need credentials to send their message." The
  Source field is the one place for a ticket.
• Use plain words. "Nothing moves a step from waiting to completed in one
  step" beats "No component completes a waiting step directly".
• Keep the record short. A reader should understand the decision in a few
  minutes without the pull request or the design document.
• Use a Mermaid diagram when a picture says it better than prose.

Checked by CI Copy Chapter

The adr-conventions rule of @n8n/code-health runs in the Static Analysis
check of every pull request. For every ADR-*.md file it checks:

• a docs/adr directory at the repository root or at a package root;
• a file name that matches the H1 and the Date field;
• the header fields, their order, and one blank line between them;
• a Decision Owner from the allowed list in
  packages/quality/policy/code-health/src/index.ts;
• a full file name in Supersedes and Superseded by;
• exactly the five sections, in order, each with content;
• the three Links fields, one line each;
• paragraph lines of at most 100 characters outside Links;
• that every record ID the record mentions is a full ID that names a file in
  this repository. A date alone, ADR-20260902, is rejected.

Run it locally:

pnpm --filter=@n8n/code-health check --rule=adr-conventions --ignore-baseline

Process Copy Chapter

1. The decision is made: in an RFC, a design review, a team discussion, or a
   pull request.
2. The Decision Owner, or a delegate, writes the record.
3. Open a pull request. The review checks that the record is accurate and
   clear. It does not reopen the decision.
4. Merge. The record is Active.
5. Implementation pull requests link to the record they implement.

Generated Postgres Schema README (`docs/generated/postgres-schema/README.md`) Copy Section

n8n database schema (PostgreSQL)

Description Copy Chapter

Auto-generated from the PostgreSQL migrations in @n8n/db. Do not edit by hand.

Tables Copy Chapter

Stored procedures and functions Copy Chapter

Relations Copy Chapter

/* Detailed source-code truncated for AI context efficiency. */

Generated by tbls

Generated Sqlite Schema README (`docs/generated/sqlite-schema/README.md`) Copy Section

n8n database schema (SQLite)

Description Copy Chapter

Auto-generated from the SQLite migrations in @n8n/db. Do not edit by hand.

Tables Copy Chapter

Relations Copy Chapter

/* Detailed source-code truncated for AI context efficiency. */

Generated by tbls

Packages @N8n Cli Docs Getting Started (`packages/@n8n/cli/docs/getting-started.md`) Copy Section

Getting Started

Installation Copy Chapter

# Use directly with npx (zero install)
npx @n8n/cli workflow list

# Or install globally
npm install @n8n/cli

Configuration Copy Chapter

The CLI needs two things: your n8n instance URL and an API key.

Option 1: Config file (recommended) Copy Section

n8n-cli config set-url https://my-n8n.app.n8n.cloud
n8n-cli config set-api-key n8n_api_xxxxx

# Verify
n8n-cli config show

Configuration is saved to ~/.n8n-cli/config.json with restricted file permissions (0600).

Option 2: Environment variables Copy Section

export N8N_URL=https://my-n8n.app.n8n.cloud
export N8N_API_KEY=n8n_api_xxxxx

Option 3: Inline flags Copy Section

n8n-cli --url=https://my-n8n.app.n8n.cloud --api-key=n8n_api_xxxxx workflow list

Resolution order Copy Section

The CLI resolves configuration in this priority order:

1. Command-line flags (--url, --api-key)
2. Environment variables (N8N_URL, N8N_API_KEY)
3. Config file (~/.n8n-cli/config.json)

Your first commands Copy Chapter

# List all workflows
n8n-cli workflow list

# Get a specific workflow as JSON
n8n-cli workflow get 1234 --format=json

# List failed executions
n8n-cli execution list --status=error --limit=5

# Create a tag
n8n-cli tag create --name=production

Output formats Copy Chapter

Every command supports three output formats:

# Human reads a table
n8n-cli workflow list

# AI agent or script gets JSON
n8n-cli workflow list --format=json | jq '.[] | select(.active) | .id'

# Pipe IDs to deactivate all workflows
n8n-cli workflow list --format=id-only | xargs -I{} n8n-cli workflow deactivate {}

AI agent skills Copy Chapter

The CLI ships with a skill that teaches AI coding agents how to use n8n-cli.

# Claude Code (installs to .claude/skills/n8n-cli/ in the current project)
n8n-cli skill install

# Claude Code (global — installs to ~/.claude/skills/n8n-cli/)
n8n-cli skill install --global

# Cursor (appends to .cursorrules)
n8n-cli skill install --target=cursor

# Windsurf (appends to .windsurfrules)
n8n-cli skill install --target=windsurf

Then use /n8n-cli in Claude Code to load the skill.

Getting help Copy Chapter

Every command has built-in help:

n8n-cli --help
n8n-cli workflow --help
n8n-cli workflow list --help

Packages @N8n Cli Docs Index (`packages/@n8n/cli/docs/index.md`) Copy Section

layout: home

hero:
name: n8n CLI
text: Manage n8n from the terminal
tagline: A lightweight client CLI for workflows, executions, credentials, and more.
actions:
- theme: brand
text: Get Started
link: /getting-started
- theme: alt
text: Command Reference
link: /commands/workflow

features:

• title: Zero Dependencies
  details: Uses native Node.js fetch — no HTTP libraries, no server stack. Installs in seconds.
• title: AI Agent Friendly
  details: Designed for Claude Code, Cursor, and other AI coding agents. Self-documenting with --help at every level.
• title: Pipe Everything
  details: JSON, table, and ID-only output formats. Pipe to jq, grep, xargs — compose with the Unix toolchain.
• title: Scriptable
  details: Meaningful exit codes, errors on stderr, data on stdout. Built for CI/CD pipelines.

Packages Frontend @N8n I18n Docs README (`packages/frontend/@n8n/i18n/docs/README.md`) Copy Section

i18n in n8n

Scope Copy Chapter

n8n allows for internalization of the majority of UI text:

• base text, e.g. menu display items in the left-hand sidebar menu,
• node text, e.g. parameter display names and placeholders in the node view,
• credential text, e.g. parameter display names and placeholders in the credential modal,
• header text, e.g. node display names and descriptions at various spots.

Currently, n8n does not allow for internalization of:

• messages from outside the editor-ui package, e.g. No active database connection,
• strings in certain Vue components, e.g. date time picker
• node subtitles, e.g. create: user or getAll: post below the node name on the canvas,
• new version notification contents in the updates panel, e.g. Includes node enhancements, and
• options that rely on loadOptionsMethod.

Pending functionality:

• Search in nodes panel by translated node name
• UI responsiveness to differently sized strings
• Locale-aware number formatting

Locale identifiers Copy Chapter

A locale identifier is a language code compatible with the Accept-Language header, e.g. de (German), es (Spanish), ja (Japanese). Regional variants of locale identifiers, such as -AT in de-AT, are not supported. For a list of all locale identifiers, see column 639-1 in this table.

By default, n8n runs in the en (English) locale. To have run it in a different locale, set the N8N_DEFAULT_LOCALE environment variable to a locale identifier. When running in a non-en locale, n8n will display UI strings for the selected locale and fall back to en for any untranslated strings.

export N8N_DEFAULT_LOCALE=de
pnpm start

Output:

Initializing n8n process
n8n ready on 0.0.0.0, port 5678
Version: 0.156.0
Locale: de

Editor is now accessible via:
http://localhost:5678/

Press "o" to open in Browser.

Base text Copy Chapter

Base text is rendered with no dependencies, i.e. base text is fixed and does not change in any circumstances. Base text is supplied by the user in one file per locale in the /frontend/@n8n/i18n package.

Locating base text Copy Section

The base text file for each locale is located at /packages/frontend/@n8n/i18n/src/locales/ and is named {localeIdentifier}.json. Keys in the base text file can be Vue component dirs, Vue component names, and references to symbols in those Vue components. These keys are added by the team as the UI is modified or expanded.

{
	"nodeCreator.categoryNames.analytics": "🇩🇪 Analytics",
	"nodeCreator.categoryNames.communication": "🇩🇪 Communication",
	"nodeCreator.categoryNames.coreNodes": "🇩🇪 Core Nodes"
}

Translating base text Copy Section

1. Select a new locale identifier, e.g. de, copy the en JSON base text file with a new name:

cp ./packages/frontend/@n8n/i18n/src/locales/en.json ./packages/frontend/@n8n/i18n/src/locales/de.json

2. Find in the UI a string to translate, and search for it in the newly created base text file. Alternatively, find in /frontend/editor-ui a call to i18n.baseText(key), e.g. i18n.baseText('workflowActivator.deactivateWorkflow'), and take note of the key and find it in the newly created base text file.

Note: If you cannot find a string in the new base text file, either it does not belong to base text (i.e., the string might be part of header text, credential text, or node text), or the string might belong to the backend, where i18n is currently unsupported.

3. Translate the string value - do not change the key. In the examples below, a string starting with 🇩🇪 stands for a string translated from English into German.

As an optional final step, remove any untranslated strings from the new base text file. Untranslated strings in the new base text file will trigger a fallback to the en base text file.

For information about interpolation and reusable base text, refer to the Addendum.

Dynamic text Copy Chapter

Dynamic text relies on data specific to each node and credential:

• headerText and nodeText in the node translation file
• credText in the credential translation file

Locating dynamic text Copy Section

Locating the credential translation file

A credential translation file is placed at /nodes-base/credentials/translations/{localeIdentifier}

credentials
	└── translations
		└── de
			├── githubApi.json
			└── githubOAuth2Api.json

Every credential must have its own credential translation file.

The name of the credential translation file must be sourced from the credential's description.name property:

export class GithubApi implements ICredentialType {
	name = 'githubApi'; // to use for credential translation file
	displayName = 'Github API';
	documentationUrl = 'github';
	properties: INodeProperties[] = [

Locating the node translation file

A node translation file is placed at /nodes-base/nodes/{node}/translations/{localeIdentifier}

GitHub
	├── GitHub.node.ts
	├── GitHubTrigger.node.ts
	└── translations
		└── de
			├── github.json
			└── githubTrigger.json

Every node must have its own node translation file.

For information about nodes in versioned dirs and grouping dirs, refer to the Addendum.

The name of the node translation file must be sourced from the node's description.name property:

export class Github implements INodeType {
	description: INodeTypeDescription = {
		displayName: 'GitHub',
		name: 'github', // to use for node translation file name
		icon: 'file:github.svg',
		group: ['input'],

Translating dynamic text Copy Section

Translating the credential translation file

Note: All translation keys are optional. Missing translation values trigger a fallback to the en locale strings.

A credential translation file, e.g. githubApi.json is an object containing keys that match the credential parameter names:

export class GithubApi implements ICredentialType {
	name = 'githubApi';
	displayName = 'Github API';
	documentationUrl = 'github';
	properties: INodeProperties[] = [
		{
			displayName: 'Github Server',
			name: 'server', // key to use in translation
			type: 'string',
			default: 'https://api.github.com',
			description: 'The server to connect to. Only has to be set if Github Enterprise is used.',
		},
		{
			displayName: 'User',
			name: 'user', // key to use in translation
			type: 'string',
			default: '',
		},
		{
			displayName: 'Access Token',
			name: 'accessToken', // key to use in translation
			type: 'string',
			default: '',
		},
	];
}

The object for each node credential parameter allows for the keys displayName, description, and placeholder.

{
	"server.displayName": "🇩🇪 Github Server",
	"server.description": "🇩🇪 The server to connect to. Only has to be set if Github Enterprise is used.",
	"user.placeholder": "🇩🇪 Hans",
	"accessToken.placeholder": "🇩🇪 123"
}

Only existing parameters are translatable. If a credential parameter does not have a description in the English original, adding a translation for that non-existing parameter will not result in the translation being displayed - the parameter will need to be added in the English original first.

Translating the node translation file

Note: All keys are optional. Missing translations trigger a fallback to the en locale strings.

Each node translation file is an object that allows for two keys, header and nodeView, which are the sections of each node translation.

The header section points to an object that may contain only two keys, displayName and description, matching the node's description.displayName and description.description.

export class Github implements INodeType {
	description: INodeTypeDescription = {
		displayName: 'GitHub', // key to use in translation
		description: 'Consume GitHub API', // key to use in translation
		name: 'github',
		icon: 'file:github.svg',
		group: ['input'],
		version: 1,

{
	"header": {
		"displayName": "🇩🇪 GitHub",
		"description": "🇩🇪 Consume GitHub API"
	}
}

Header text is used wherever the node's display name and description are needed:

In turn, the nodeView section points to an object containing translation keys that match the node's operational parameters, found in the *.node.ts and also found in *Description.ts files in the same dir.

export class Github implements INodeType {
	description: INodeTypeDescription = {
		displayName: 'GitHub',
		name: 'github',
		properties: [
			{
				displayName: 'Resource',
				name: 'resource', // key to use in translation
				type: 'options',
				options: [],
				default: 'issue',
				description: 'The resource to operate on.',
			},

{
	"nodeView.resource.displayName": "🇩🇪 Resource"
}

A node parameter allows for different translation keys depending on parameter type.

`string`, `number` and `boolean` parameters

Allowed keys: displayName, description, placeholder

{
	displayName: 'Repository Owner',
	name: 'owner', // key to use in translation
	type: 'string',
	required: true,
	placeholder: 'n8n-io',
	description: 'Owner of the repository.',
},

{
	"nodeView.owner.displayName": "🇩🇪 Repository Owner",
	"nodeView.owner.placeholder": "🇩🇪 n8n-io",
	"nodeView.owner.description": "🇩🇪 Owner of the repository"
}

`options` parameter

Allowed keys: displayName, description, placeholder

Allowed subkeys: options.{optionName}.displayName and options.{optionName}.description.

{
	displayName: 'Resource',
	name: 'resource',
	type: 'options',
	options: [
		{
			name: 'File',
			value: 'file', // key to use in translation
		},
		{
			name: 'Issue',
			value: 'issue', // key to use in translation
		},
	],
	default: 'issue',
	description: 'Resource to operate on',
},

{
	"nodeView.resource.displayName": "🇩🇪 Resource",
	"nodeView.resource.description": "🇩🇪 Resource to operate on",
	"nodeView.resource.options.file.name": "🇩🇪 File",
	"nodeView.resource.options.issue.name": "🇩🇪 Issue"
}

For nodes whose credentials may be used in the HTTP Request node, an additional option Custom API Call is injected into the Resource and Operation parameters. Use the __CUSTOM_API_CALL__ key to translate this additional option.

{
	"nodeView.resource.options.file.name": "🇩🇪 File",
	"nodeView.resource.options.issue.name": "🇩🇪 Issue",
	"nodeView.resource.options.__CUSTOM_API_CALL__.name": "🇩🇪 Custom API Call"
}

`collection` and `fixedCollection` parameters

Allowed keys: displayName, description, placeholder, multipleValueButtonText

Example of collection parameter:

{
	displayName: 'Labels',
	name: 'labels', // key to use in translation
	type: 'collection',
	typeOptions: {
		multipleValues: true,
		multipleValueButtonText: 'Add Label',
	},
	displayOptions: {
		show: {
			operation: [
				'create',
			],
			resource: [
				'issue',
			],
		},
	},
	default: { 'label': '' },
	options: [
		{
			displayName: 'Label',
			name: 'label', // key to use in translation
			type: 'string',
			default: '',
			description: 'Label to add to issue',
		},
	],
},

{
	"nodeView.labels.displayName": "🇩🇪 Labels",
	"nodeView.labels.multipleValueButtonText": "🇩🇪 Add Label",
	"nodeView.labels.options.label.displayName": "🇩🇪 Label",
	"nodeView.labels.options.label.description": "🇩🇪 Label to add to issue",
	"nodeView.labels.options.label.placeholder": "🇩🇪 Some placeholder"
}

Example of fixedCollection parameter:

{
	displayName: 'Additional Parameters',
	name: 'additionalParameters',
	placeholder: 'Add Parameter',
	description: 'Additional fields to add.',
	type: 'fixedCollection',
	default: {},
	displayOptions: {
		show: {
			operation: [
				'create',
				'delete',
				'edit',
			],
			resource: [
				'file',
			],
		},
	},
	options: [
		{
			name: 'author',
			displayName: 'Author',
			values: [
				{
					displayName: 'Name',
					name: 'name',
					type: 'string',
					default: '',
					description: 'Name of the author of the commit',
					placeholder: 'John',
				},
				{
					displayName: 'Email',
					name: 'email',
					type: 'string',
					default: '',
					description: 'Email of the author of the commit',
					placeholder: '[email protected]',
				},
			],
		},
	],
}

{
	"nodeView.additionalParameters.displayName": "🇩🇪 Additional Parameters",
	"nodeView.additionalParameters.placeholder": "🇩🇪 Add Field",
	"nodeView.additionalParameters.options.author.displayName": "🇩🇪 Author",
	"nodeView.additionalParameters.options.author.values.name.displayName": "🇩🇪 Name",
	"nodeView.additionalParameters.options.author.values.name.description": "🇩🇪 Name of the author of the commit",
	"nodeView.additionalParameters.options.author.values.name.placeholder": "🇩🇪 Jan",
	"nodeView.additionalParameters.options.author.values.email.displayName": "🇩🇪 Email",
	"nodeView.additionalParameters.options.author.values.email.description": "🇩🇪 Email of the author of the commit",
	"nodeView.additionalParameters.options.author.values.email.placeholder": "🇩🇪 [email protected]"
}

For information on reusable dynamic text, refer to the Addendum.

Building translations

Base text Copy Chapter

When translating a base text file at /packages/frontend/@n8n/i18n/src/locales/{localeIdentifier}.json:

1. Open a terminal:

export N8N_DEFAULT_LOCALE=de
pnpm start

2. Open another terminal:

export N8N_DEFAULT_LOCALE=de
cd packages/frontend/editor-ui
pnpm dev

Changing the base text file will trigger a rebuild of the client at http://localhost:8080.

Dynamic text Copy Chapter

When translating a dynamic text file at /packages/nodes-base/nodes/{node}/translations/{localeIdentifier}/{node}.json,

1. Open a terminal:

export N8N_DEFAULT_LOCALE=de
pnpm start

2. Open another terminal:

export N8N_DEFAULT_LOCALE=de
cd packages/nodes-base
pnpm n8n-generate-translations
pnpm watch

After changing the dynamic text file:

1. Stop and restart the first terminal.
2. Refresh the browser at http://localhost:5678

If a headerText section was changed, re-run pnpm n8n-generate-translations in /nodes-base.

Note: To translate base and dynamic text simultaneously, run three terminals following the steps from both sections (first terminal running only once) and browse http://localhost:8080.

ADR TEMPLATE (`docs/ADR_TEMPLATE.md`) Copy Section

Date: YYYY-MM-DD

Status:

Decision Owner:

Source:

Supersedes:

Superseded by:

Context Copy Chapter

Decision Copy Chapter

Alternatives Considered Copy Chapter

Consequences Copy Chapter

Links Copy Chapter

RFC:

Documentation:

Related ADRs:

Db (`docs/db.md`) Copy Section

Database

n8n persists its state in a relational database, accessed through TypeORM. The
schema supports both SQLite (the default) and PostgreSQL, and is defined by the
migrations in @n8n/db rather than the entities (entities run with
synchronize: false).

Schema reference Copy Chapter

Auto-generated documentation of the schema, one set per supported database:

• SQLite
• PostgreSQL

Each set lists every table with its columns, types, defaults, indexes, and
foreign keys, plus a Mermaid ER diagram of the relationships. The two differ
where the column types do (e.g. datetime vs timestamptz, text/simple-json
vs json/jsonb, boolean representation).

How it's generated Copy Section

The generator spins up an empty database, runs the full @n8n/db migration set
against it, and points tbls at the result.
SQLite uses a throwaway file; PostgreSQL uses a throwaway testcontainer, so
Docker is required.

# Regenerate both (requires Docker; tbls locally via `brew install tbls`)
pnpm db:schema:docs

# Verify the committed docs match the current migrations
pnpm db:schema:check

The schema reference is auto-generated — do not edit by hand. CI fails when
a migration changes the schema but the docs weren't regenerated; when that
happens, run pnpm db:schema:docs and commit the result.

Generated Postgres Schema Public.Activity Event (`docs/generated/postgres-schema/public.activity_event.md`) Copy Section

public.activity_event

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram

"public.activity_event" }o--|| "public.project" : "FOREIGN KEY (#quot;projectId#quot;) REFERENCES project(id) ON DELETE CASCADE"
"public.activity_event" }o--o| "public.user" : "FOREIGN KEY (#quot;userId#quot;) REFERENCES #quot;user#quot;(id) ON DELETE SET NULL"

"public.activity_event" {
  varchar_64_ action
  varchar_32_ category
  timestamp_3__with_time_zone createdAt
  json data
  integer id
  varchar_36_ projectId FK
  varchar_36_ resourceId
  text resourceName
  varchar_32_ resourceType
  integer typeVersion
  uuid userId FK
}
"public.project" {
  timestamp_3__with_time_zone createdAt
  uuid creatorId FK
  json customTelemetryTags
  varchar_512_ description
  json icon
  varchar_36_ id
  varchar_255_ name
  varchar_36_ type
  timestamp_3__with_time_zone updatedAt
}
"public.user" {
  timestamp_3__with_time_zone createdAt
  boolean disabled
  varchar_255_ email
  varchar_32_ firstName
  uuid id
  date lastActiveAt
  varchar_32_ lastName
  boolean mfaEnabled
  text mfaRecoveryCodes
  text mfaSecret
  varchar_255_ password
  json personalizationAnswers
  varchar_128_ roleSlug FK
  json settings
  timestamp_3__with_time_zone updatedAt
}

Generated by tbls

Generated Postgres Schema Public.Agent Background Job (`docs/generated/postgres-schema/public.agent_background_job.md`) Copy Section

public.agent_background_job

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

/* Detailed source-code truncated for AI context efficiency. */

Generated by tbls

Generated Postgres Schema Public.Agent Budget Applied Call (`docs/generated/postgres-schema/public.agent_budget_applied_call.md`) Copy Section

public.agent_budget_applied_call

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram


"public.agent_budget_applied_call" {
  uuid callId
  timestamp_3__with_time_zone createdAt
}

Generated by tbls

Generated Postgres Schema Public.Agent Budget Spend (`docs/generated/postgres-schema/public.agent_budget_spend.md`) Copy Section

public.agent_budget_spend

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram


"public.agent_budget_spend" {
  timestamp_3__with_time_zone createdAt
  varchar_128_ key
  double_precision totalUsd
  timestamp_3__with_time_zone updatedAt
}

Generated by tbls

Generated Postgres Schema Public.Agent Channel Status (`docs/generated/postgres-schema/public.agent_channel_status.md`) Copy Section

public.agent_channel_status

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram

"public.agent_channel_status" }o--|| "public.agents" : "FOREIGN KEY (#quot;agentId#quot;) REFERENCES agents(id) ON DELETE CASCADE"

"public.agent_channel_status" {
  varchar_36_ agentId FK
  integer attempts
  timestamp_3__with_time_zone backoffUntil
  timestamp_3__with_time_zone createdAt
  varchar_36_ credentialId
  text errorMessage
  timestamp_3__with_time_zone expiresAt
  varchar_128_ hostId
  varchar_64_ integrationType
  varchar_16_ status
  timestamp_3__with_time_zone updatedAt
}
"public.agents" {
  varchar_36_ activeVersionId FK
  boolean availableInMCP
  timestamp_3__with_time_zone createdAt
  varchar_36_ id
  json integrations
  varchar_128_ name
  varchar_255_ projectId FK
  integer revision
  json schema
  varchar_16_ scope
  timestamp_3__with_time_zone setupCompletedAt
  json skills
  json tools
  timestamp_3__with_time_zone updatedAt
  varchar_36_ versionId
}

Generated by tbls

Generated Postgres Schema Public.Agent Chat Attachments (`docs/generated/postgres-schema/public.agent_chat_attachments.md`) Copy Section

public.agent_chat_attachments

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram

"public.agent_chat_attachments" }o--o| "public.agents" : "FOREIGN KEY (#quot;agentId#quot;) REFERENCES agents(id) ON DELETE CASCADE"
"public.agent_chat_attachments" }o--|| "public.project" : "FOREIGN KEY (#quot;projectId#quot;) REFERENCES project(id) ON DELETE CASCADE"

"public.agent_chat_attachments" {
  varchar_36_ agentId FK
  text binaryDataId
  timestamp_3__with_time_zone createdAt
  varchar_255_ fileName
  integer fileSizeBytes
  varchar_16_ id
  varchar_255_ mimeType
  varchar_36_ projectId FK
  varchar_255_ resourceId
  varchar_32_ source
  varchar_128_ threadId
  timestamp_3__with_time_zone updatedAt
}
"public.agents" {
  varchar_36_ activeVersionId FK
  boolean availableInMCP
  timestamp_3__with_time_zone createdAt
  varchar_36_ id
  json integrations
  varchar_128_ name
  varchar_255_ projectId FK
  integer revision
  json schema
  varchar_16_ scope
  timestamp_3__with_time_zone setupCompletedAt
  json skills
  json tools
  timestamp_3__with_time_zone updatedAt
  varchar_36_ versionId
}
"public.project" {
  timestamp_3__with_time_zone createdAt
  uuid creatorId FK
  json customTelemetryTags
  varchar_512_ description
  json icon
  varchar_36_ id
  varchar_255_ name
  varchar_36_ type
  timestamp_3__with_time_zone updatedAt
}

Generated by tbls

Generated Postgres Schema Public.Agent Chat Subscriptions (`docs/generated/postgres-schema/public.agent_chat_subscriptions.md`) Copy Section

public.agent_chat_subscriptions

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram

"public.agent_chat_subscriptions" }o--|| "public.agents" : "FOREIGN KEY (#quot;agentId#quot;) REFERENCES agents(id) ON DELETE CASCADE"

"public.agent_chat_subscriptions" {
  varchar_36_ agentId FK
  timestamp_3__with_time_zone createdAt
  varchar_255_ credentialId
  varchar_64_ integrationType
  varchar_255_ threadId
  timestamp_3__with_time_zone updatedAt
}
"public.agents" {
  varchar_36_ activeVersionId FK
  boolean availableInMCP
  timestamp_3__with_time_zone createdAt
  varchar_36_ id
  json integrations
  varchar_128_ name
  varchar_255_ projectId FK
  integer revision
  json schema
  varchar_16_ scope
  timestamp_3__with_time_zone setupCompletedAt
  json skills
  json tools
  timestamp_3__with_time_zone updatedAt
  varchar_36_ versionId
}

Generated by tbls

Generated Postgres Schema Public.Agent Checkpoints (`docs/generated/postgres-schema/public.agent_checkpoints.md`) Copy Section

public.agent_checkpoints

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram

"public.agent_checkpoints" }o--o| "public.agents" : "FOREIGN KEY (#quot;agentId#quot;) REFERENCES agents(id) ON DELETE CASCADE"

"public.agent_checkpoints" {
  varchar_255_ agentId FK
  timestamp_3__with_time_zone createdAt
  boolean expired
  varchar_255_ runId
  text state
  text threadId
  timestamp_3__with_time_zone updatedAt
}
"public.agents" {
  varchar_36_ activeVersionId FK
  boolean availableInMCP
  timestamp_3__with_time_zone createdAt
  varchar_36_ id
  json integrations
  varchar_128_ name
  varchar_255_ projectId FK
  integer revision
  json schema
  varchar_16_ scope
  timestamp_3__with_time_zone setupCompletedAt
  json skills
  json tools
  timestamp_3__with_time_zone updatedAt
  varchar_36_ versionId
}

Generated by tbls

Generated Postgres Schema Public.Agent Credential Dependency (`docs/generated/postgres-schema/public.agent_credential_dependency.md`) Copy Section

public.agent_credential_dependency

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram

"public.agent_credential_dependency" }o--|| "public.agents" : "FOREIGN KEY (#quot;agentId#quot;) REFERENCES agents(id) ON DELETE CASCADE"
"public.agent_credential_dependency" }o--|| "public.credentials_entity" : "FOREIGN KEY (#quot;credentialId#quot;) REFERENCES credentials_entity(id) ON DELETE CASCADE"

"public.agent_credential_dependency" {
  varchar_36_ agentId FK
  timestamp_3__with_time_zone createdAt
  varchar_36_ credentialId FK
}
"public.agents" {
  varchar_36_ activeVersionId FK
  boolean availableInMCP
  timestamp_3__with_time_zone createdAt
  varchar_36_ id
  json integrations
  varchar_128_ name
  varchar_255_ projectId FK
  integer revision
  json schema
  varchar_16_ scope
  timestamp_3__with_time_zone setupCompletedAt
  json skills
  json tools
  timestamp_3__with_time_zone updatedAt
  varchar_36_ versionId
}
"public.credentials_entity" {
  timestamp_3__with_time_zone createdAt
  text data
  text description
  varchar_36_ id
  boolean isGlobal
  boolean isManaged
  boolean isResolvable
  varchar_128_ name
  timestamp_3__with_time_zone pendingAuthorizationExpiresAt
  boolean resolvableAllowFallback
  varchar_16_ resolverId FK
  varchar_128_ type
  timestamp_3__with_time_zone updatedAt
  varchar_16_ usageScope
}

Generated by tbls

Generated Postgres Schema Public.Agent Eval Dataset (`docs/generated/postgres-schema/public.agent_eval_dataset.md`) Copy Section

public.agent_eval_dataset

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

/* Detailed source-code truncated for AI context efficiency. */

Generated by tbls

Generated Postgres Schema Public.Agent Eval Rating (`docs/generated/postgres-schema/public.agent_eval_rating.md`) Copy Section

public.agent_eval_rating

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram

"public.agent_eval_rating" }o--o| "public.user" : "FOREIGN KEY (#quot;ratedById#quot;) REFERENCES #quot;user#quot;(id) ON DELETE SET NULL"
"public.agent_eval_rating" }o--|| "public.agent_eval_result" : "FOREIGN KEY (#quot;resultId#quot;) REFERENCES agent_eval_result(id) ON DELETE CASCADE"

"public.agent_eval_rating" {
  text comment
  json correction
  timestamp_3__with_time_zone createdAt
  varchar_36_ id
  uuid ratedById FK
  varchar_36_ resultId FK
  timestamp_3__with_time_zone updatedAt
  varchar_8_ vote
}
"public.user" {
  timestamp_3__with_time_zone createdAt
  boolean disabled
  varchar_255_ email
  varchar_32_ firstName
  uuid id
  date lastActiveAt
  varchar_32_ lastName
  boolean mfaEnabled
  text mfaRecoveryCodes
  text mfaSecret
  varchar_255_ password
  json personalizationAnswers
  varchar_128_ roleSlug FK
  json settings
  timestamp_3__with_time_zone updatedAt
}
"public.agent_eval_result" {
  timestamp_3__with_time_zone completedAt
  timestamp_3__with_time_zone createdAt
  varchar_255_ errorCode
  json errorDetails
  varchar_36_ id
  json input
  json metrics
  json output
  timestamp_3__with_time_zone runAt
  varchar_36_ runId FK
  integer runIndex
  varchar_255_ sourceRowId
  varchar status
  json toolCalls
  timestamp_3__with_time_zone updatedAt
  json verdict
}

Generated by tbls

Generated Postgres Schema Public.Agent Eval Result (`docs/generated/postgres-schema/public.agent_eval_result.md`) Copy Section

public.agent_eval_result

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram

"public.agent_eval_rating" }o--|| "public.agent_eval_result" : "FOREIGN KEY (#quot;resultId#quot;) REFERENCES agent_eval_result(id) ON DELETE CASCADE"
"public.agent_eval_result" }o--|| "public.agent_eval_run" : "FOREIGN KEY (#quot;runId#quot;) REFERENCES agent_eval_run(id) ON DELETE CASCADE"

"public.agent_eval_result" {
  timestamp_3__with_time_zone completedAt
  timestamp_3__with_time_zone createdAt
  varchar_255_ errorCode
  json errorDetails
  varchar_36_ id
  json input
  json metrics
  json output
  timestamp_3__with_time_zone runAt
  varchar_36_ runId FK
  integer runIndex
  varchar_255_ sourceRowId
  varchar status
  json toolCalls
  timestamp_3__with_time_zone updatedAt
  json verdict
}
"public.agent_eval_rating" {
  text comment
  json correction
  timestamp_3__with_time_zone createdAt
  varchar_36_ id
  uuid ratedById FK
  varchar_36_ resultId FK
  timestamp_3__with_time_zone updatedAt
  varchar_8_ vote
}
"public.agent_eval_run" {
  varchar_36_ agentVersionId
  boolean cancelRequested
  timestamp_3__with_time_zone completedAt
  timestamp_3__with_time_zone createdAt
  uuid createdById FK
  varchar_36_ datasetId FK
  varchar_255_ errorCode
  json errorDetails
  varchar_36_ id
  json metrics
  timestamp_3__with_time_zone runAt
  varchar_255_ runningInstanceId
  varchar status
  timestamp_3__with_time_zone updatedAt
}

Generated by tbls

Generated Postgres Schema Public.Agent Eval Run (`docs/generated/postgres-schema/public.agent_eval_run.md`) Copy Section

public.agent_eval_run

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

/* Detailed source-code truncated for AI context efficiency. */

Generated by tbls

Generated Postgres Schema Public.Agent Execution (`docs/generated/postgres-schema/public.agent_execution.md`) Copy Section

public.agent_execution

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

/* Detailed source-code truncated for AI context efficiency. */

Generated by tbls

Generated Postgres Schema Public.Agent Execution Message Links (`docs/generated/postgres-schema/public.agent_execution_message_links.md`) Copy Section

public.agent_execution_message_links

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram

"public.agent_execution_message_links" }o--|| "public.agent_execution" : "FOREIGN KEY (#quot;executionId#quot;) REFERENCES agent_execution(id) ON DELETE CASCADE"
"public.agent_execution_message_links" }o--|| "public.agents_messages" : "FOREIGN KEY (#quot;messageId#quot;) REFERENCES agents_messages(id) ON DELETE CASCADE"

"public.agent_execution_message_links" {
  timestamp_3__with_time_zone createdAt
  varchar_6_ direction
  varchar_36_ executionId FK
  varchar_36_ messageId FK
  integer position
}
"public.agent_execution" {
  boolean acceptsSteering
  json attachments
  json author
  integer completionTokens
  double_precision cost
  timestamp_3__with_time_zone createdAt
  integer duration
  text error
  json failureSummary
  varchar_32_ finishReason
  varchar_64_ guardrailCode
  varchar_16_ hitlStatus
  varchar_36_ id
  varchar_255_ model
  integer promptTokens
  varchar_32_ source
  timestamp_3__with_time_zone startedAt
  varchar_16_ status
  timestamp_3__with_time_zone stoppedAt
  varchar_2_ storedAt
  varchar_128_ threadId FK
  json timeline
  integer totalTokens
  timestamp_3__with_time_zone updatedAt
  text userMessage
}
"public.agents_messages" {
  json author
  json content
  timestamp_3__with_time_zone createdAt
  varchar_36_ id
  json modelContent
  timestamp_3__with_time_zone modelContextAt
  json origin
  varchar_255_ resourceId
  varchar_36_ role
  varchar_255_ threadId FK
  varchar_36_ type
  timestamp_3__with_time_zone updatedAt
}

Generated by tbls

Generated Postgres Schema Public.Agent Execution Threads (`docs/generated/postgres-schema/public.agent_execution_threads.md`) Copy Section

public.agent_execution_threads

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

/* Detailed source-code truncated for AI context efficiency. */

Generated by tbls

Generated Postgres Schema Public.Agent Files (`docs/generated/postgres-schema/public.agent_files.md`) Copy Section

public.agent_files

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram

"public.agent_files" }o--|| "public.agents" : "FOREIGN KEY (#quot;agentId#quot;) REFERENCES agents(id) ON DELETE CASCADE"

"public.agent_files" {
  varchar_36_ agentId FK
  text binaryDataId
  timestamp_3__with_time_zone createdAt
  varchar_255_ fileName
  integer fileSizeBytes
  varchar_16_ id
  varchar_255_ mimeType
  text storageKey
  varchar_2_ storedAt
  timestamp_3__with_time_zone updatedAt
}
"public.agents" {
  varchar_36_ activeVersionId FK
  boolean availableInMCP
  timestamp_3__with_time_zone createdAt
  varchar_36_ id
  json integrations
  varchar_128_ name
  varchar_255_ projectId FK
  integer revision
  json schema
  varchar_16_ scope
  timestamp_3__with_time_zone setupCompletedAt
  json skills
  json tools
  timestamp_3__with_time_zone updatedAt
  varchar_36_ versionId
}

Generated by tbls

Generated Postgres Schema Public.Agent History (`docs/generated/postgres-schema/public.agent_history.md`) Copy Section

public.agent_history

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

/* Detailed source-code truncated for AI context efficiency. */

Generated by tbls

Generated Postgres Schema Public.Agent Message Queue (`docs/generated/postgres-schema/public.agent_message_queue.md`) Copy Section

public.agent_message_queue

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

/* Detailed source-code truncated for AI context efficiency. */

Generated by tbls

Generated Postgres Schema Public.Agent Plan (`docs/generated/postgres-schema/public.agent_plan.md`) Copy Section

public.agent_plan

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

/* Detailed source-code truncated for AI context efficiency. */

Generated by tbls

Generated Postgres Schema Public.Agent Plan History (`docs/generated/postgres-schema/public.agent_plan_history.md`) Copy Section

public.agent_plan_history

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram

"public.agent_plan_history" }o--|| "public.agent_plan" : "FOREIGN KEY (#quot;planId#quot;) REFERENCES agent_plan(id) ON DELETE CASCADE"

"public.agent_plan_history" {
  timestamp_3__with_time_zone closedAt
  timestamp_3__with_time_zone createdAt
  json data
  integer formatVersion
  uuid planId FK
  integer revision
}
"public.agent_plan" {
  timestamp_3__with_time_zone closedAt
  timestamp_3__with_time_zone createdAt
  json data
  integer formatVersion
  uuid id
  integer revision
  varchar_128_ threadId FK
  timestamp_3__with_time_zone updatedAt
}

Generated by tbls

Generated Postgres Schema Public.Agent Skill Dependency (`docs/generated/postgres-schema/public.agent_skill_dependency.md`) Copy Section

public.agent_skill_dependency

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

/* Detailed source-code truncated for AI context efficiency. */

Generated by tbls

Generated Postgres Schema Public.Agent Task Definition (`docs/generated/postgres-schema/public.agent_task_definition.md`) Copy Section

public.agent_task_definition

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram

"public.agent_task_definition" }o--|| "public.agents" : "FOREIGN KEY (#quot;agentId#quot;) REFERENCES agents(id) ON DELETE CASCADE"

"public.agent_task_definition" {
  varchar_36_ agentId FK
  timestamp_3__with_time_zone createdAt
  varchar_128_ cronExpression
  varchar_32_ id
  varchar_128_ name
  text objective
  varchar_64_ timezone
  timestamp_3__with_time_zone updatedAt
}
"public.agents" {
  varchar_36_ activeVersionId FK
  boolean availableInMCP
  timestamp_3__with_time_zone createdAt
  varchar_36_ id
  json integrations
  varchar_128_ name
  varchar_255_ projectId FK
  integer revision
  json schema
  varchar_16_ scope
  timestamp_3__with_time_zone setupCompletedAt
  json skills
  json tools
  timestamp_3__with_time_zone updatedAt
  varchar_36_ versionId
}

Generated by tbls

Generated Postgres Schema Public.Agent Task Run Lock (`docs/generated/postgres-schema/public.agent_task_run_lock.md`) Copy Section

public.agent_task_run_lock

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram

"public.agent_task_run_lock" }o--|| "public.agents" : "FOREIGN KEY (#quot;agentId#quot;) REFERENCES agents(id) ON DELETE CASCADE"

"public.agent_task_run_lock" {
  varchar_36_ agentId FK
  timestamp_3__with_time_zone createdAt
  timestamp_3__with_time_zone heldUntil
  uuid holderId
  varchar_32_ taskId
  timestamp_3__with_time_zone updatedAt
}
"public.agents" {
  varchar_36_ activeVersionId FK
  boolean availableInMCP
  timestamp_3__with_time_zone createdAt
  varchar_36_ id
  json integrations
  varchar_128_ name
  varchar_255_ projectId FK
  integer revision
  json schema
  varchar_16_ scope
  timestamp_3__with_time_zone setupCompletedAt
  json skills
  json tools
  timestamp_3__with_time_zone updatedAt
  varchar_36_ versionId
}

Generated by tbls

Generated Postgres Schema Public.Agent Task Snapshot (`docs/generated/postgres-schema/public.agent_task_snapshot.md`) Copy Section

public.agent_task_snapshot

Columns Copy Chapter

Constraints Copy Chapter

Indexes Copy Chapter

Relations Copy Chapter

erDiagram

"public.agent_task_snapshot" }o--|| "public.agent_history" : "FOREIGN KEY (#quot;versionId#quot;) REFERENCES agent_history(#quot;versionId#quot;) ON DELETE CASCADE"

"public.agent_task_snapshot" {
  timestamp_3__with_time_zone createdAt
  varchar_128_ cronExpression
  boolean enabled
  varchar_128_ name
  text objective
  varchar_32_ taskId
  varchar_64_ timezone
  timestamp_3__with_time_zone updatedAt
  varchar_36_ versionId FK
}
"public.agent_history" {
  varchar_36_ agentId FK
  varchar_255_ author
  timestamp_3__with_time_zone createdAt
  uuid publishedById FK
  json schema
  json skills
  json tools
  timestamp_3__with_time_zone updatedAt
  varchar_36_ versionId
}

Generated by tbls

Generated Postgres Schema Public.Agent Thread Grants (`docs/generated/postgres-schema/public.agent_thread_grants.md`) Copy Section

public.agent_thread_grants

Columns Copy Chapter