Skip to main content

Agent Studio Guide

The Agent Studio is the unified interface for creating, configuring, and managing AI agents in Datafi. It combines the Agent Builder (configuration) and Workflow Builder (visual orchestration) into a single workspace. This guide walks through every section of the Studio.


Opening the Agent Studio

Navigate to AI > Agent Catalog and either:

  • Click New Agent to create a new agent, or
  • Click an existing agent card and then Edit to open it in the Studio.

Two Creation Paths

MethodDescriptionBest For
ManualStart with a blank agent or select a template. Fill in each tab yourself.Experienced users who know exactly what they want.
AI-AssistedDescribe your agent in natural language. The conversational wizard gathers requirements and generates a workflow.New users, rapid prototyping, complex workflows.

When creating manually, you provide a title (display name) and optional description. The system auto-generates a unique agent name (identifier) from the title.


Identity Tab

The Identity tab defines who the agent is and what it aims to accomplish.

FieldDescription
TitleHuman-readable display name shown in the catalog and UI.
NameUnique identifier, auto-generated from the title. Used in API calls and references.
VersionSemantic version (e.g., 1.0.0). Increment when making changes.
DescriptionSummary of the agent's purpose, displayed in the catalog card.
AuthorThe user or team that created the agent.
TagsLabels for categorization and discovery (e.g., sales, analytics, monitoring).
IconVisual identifier. Choose from Material Symbols icons or upload a custom logo image. Toggle between icon and upload modes.
GoalsList of objectives the agent pursues during each run.
Success CriteriaMeasurable conditions that define a successful run (e.g., "Report generated in under 60 seconds").

Capabilities Tab

Capabilities define what tools and data sources the agent can use.

Tools

Add tools from the available tool library. For each tool, configure:

  • Permissions -- Which operations the tool can perform: Read, Write, Execute, Delete.
  • Database access -- Which data sources the tool can query.
  • Row limits -- Maximum number of rows a query tool can return.
  • Complexity constraints -- Limits on query complexity (joins, subqueries).
  • Output format -- Expected output type (JSON, text, table).
  • Channel/recipient restrictions -- For communication tools like email, restrict allowed recipients.
  • TTL and size limits -- Time-to-live and maximum output size.

Available Tools

ToolCategoryDescription
queryDataExecute PRQL/SQL queries against connected data sources
searchDataSemantic search across data catalog metadata
llmAICall the configured LLM for reasoning or generation
visionAIAnalyze images using GPT-4 Vision
vision_extractionAIExtract structured data from documents
web_searchExternalSearch the web for information
web_fetchExternalFetch and parse content from a URL
http_apiExternalMake HTTP requests to external APIs
emailCommunicationSend email notifications
ftpCommunicationUpload/download files from FTP/SFTP servers
jsonTransformParse, transform, and query JSON using JQ expressions
arrayTransformMap, filter, reduce, and sort array data
csvTransformParse or generate CSV files
csv_writerTransformGenerate CSV files from structured data
csv_formatterTransformFormat and transform CSV data
markdownFormatGenerate formatted markdown documents
markdown_table_formatterFormatFormat data as HTML or markdown tables
regressionAnalyticsStatistical linear regression analysis
summarizeAISummarize text with configurable length

Data Sources

Specify which connected data sources the agent can access. The agent can only query listed sources, and all queries are further restricted by ABAC policies.

Output Formats

Define the formats the agent produces: text, json, markdown, table, or any combination.


Behavior Tab

Behavior controls how the agent executes and reasons.

SettingDescriptionOptions
Execution ModeHow steps are processed.Sequential, Parallel, Hybrid
TimeoutMaximum execution time per run.1 -- 3600 seconds
Concurrency LimitMaximum parallel executions.1 -- 100

Retry Policy

Configure how the agent handles transient failures:

SettingDescription
Max AttemptsNumber of retry attempts before failing.
Backoff StrategyFixed, Linear, or Exponential delay between retries.
Initial DelayWait time before the first retry.
Max DelayUpper bound on retry delay.
Retry OnError types that trigger a retry (e.g., network_error, timeout, rate_limit).
Do Not RetryError types that should fail immediately (e.g., validation_error, permission_denied).

Reasoning Strategy

StrategyBest For
Step-by-stepLinear analysis, logical progression
Parallel explorationOpen-ended questions, multiple valid approaches
Hypothesis-drivenInvestigative analysis, anomaly detection
Depth-firstDetailed root cause analysis
Breadth-firstExploratory analysis, option comparison

Safety & Security Tab

Safety settings constrain the agent to keep it secure, efficient, and compliant.

Constraints

Free-text rules the agent must follow. Examples:

  • "Never modify production data"
  • "PII must be masked in email outputs"
  • "Only read from approved data sources"

Validation Rules

Define rules with conditions and error handling behavior. Validation runs before tool execution.

Output Filters

Automatically redact or transform sensitive values in agent output.

Resource Limits

ResourceDescriptionDefaultMaximum
Tokens per requestLLM tokens per individual tool call.10,000100,000
API calls per runMaximum external API calls.100500
Daily token budgetTotal tokens across all runs per day.50,000500,000

Security Controls

ControlDescription
PII PreventionScrub personally identifiable information before sending to LLMs.
SQL Injection PreventionAll generated queries pass through parameterized validation.
Database Access ControlSpecify allowed and blocked databases for the agent.

Testing Tab

Test your agent before publishing to ensure it behaves correctly.

Test Scenarios

Define test cases with:

  • Query/Input -- Sample input parameters for the test.
  • Context -- Additional context data to provide.
  • Expected Output -- What the agent should produce.
  • Assertions -- Validation rules that must pass (e.g., execution_time_ms < 60000).

Evaluation Metrics

Track quality metrics across test runs:

  • Accuracy -- How often the agent produces correct results.
  • Latency -- Execution time percentiles (p50, p95, p99).
  • Token efficiency -- Tokens consumed relative to output quality.

Regression Tests

Save test scenarios as regression tests that run automatically when the agent specification is modified.


Monitoring Tab

Configure observability for production agents.

Logging

SettingDescription
Log LevelDebug, Info, Warning, Error
Include Stack TracesCapture full stack traces for errors.
DestinationConsole, File, Syslog, or external logging service.

Tracing

SettingDescription
Enable TracingTurn on distributed tracing for execution flows.
Sampling RatePercentage of runs to trace (0.0 -- 1.0).

Metrics & Alerts

Define custom metrics to track (counters, histograms, gauges) and alert thresholds that trigger notifications.

Audit Trail

When enabled, all agent actions, tool invocations, and data access are recorded in the audit log.


Deployment Tab

Configure how and when the agent runs.

Trigger Types

TriggerDescriptionConfiguration
ManualRun on demand from the UI or API.No additional config needed.
ScheduleRun on a cron schedule.Cron expression + timezone.
PollingCheck a condition at intervals, run when met.Interval, initial delay, error backoff, max consecutive errors.
EventRun when a platform event occurs.Event type, filter conditions.
WebhookRun when an HTTP request hits the agent's endpoint.Webhook URL (auto-generated).

Schedule Configuration

Use standard cron expressions:

┌───────────── minute (0-59)
│ ┌───────────── hour (0-23)
│ │ ┌───────────── day of month (1-31)
│ │ │ ┌───────────── month (1-12)
│ │ │ │ ┌───────────── day of week (0-7, MON-SUN)
│ │ │ │ │
* * * * *

Examples:

  • 0 8 * * MON -- Every Monday at 8:00 AM
  • 0 */6 * * * -- Every 6 hours
  • 30 9 1 * * -- First day of each month at 9:30 AM

Always specify a timezone (e.g., America/New_York) to avoid ambiguity.

Polling Configuration

SettingDescription
IntervalTime between polls (e.g., 5m, 1h).
Initial DelayWait time before the first poll.
Error BackoffMultiplier applied to interval after consecutive errors.
Max ErrorsNumber of consecutive errors before stopping the poller.

Workflow Tab

The Workflow tab opens the visual workflow editor -- a drag-and-drop canvas for building execution graphs.

Canvas Basics

  • Add nodes -- Drag node types from the palette or right-click the canvas.
  • Connect nodes -- Click and drag from an output port to an input port.
  • Configure nodes -- Click a node to open the properties panel on the right.
  • Auto-layout -- Click the layout button to automatically arrange nodes in a clean hierarchy.

Node Types

TypeIconDescription
StartPlayEntry point, receives input parameters.
EndStopTerminal node, returns output.
ActionGearExecutes a tool (query, email, LLM, etc.).
ConditionDiamondEvaluates an expression and branches.
LoopRefreshIterates over a collection or repeats until a condition.
ParallelForkSplits into concurrent branches.
TransformShuffleApplies data transformation.
HumanInputPersonPauses for user input or approval.
WaitClockPauses until a condition or timeout.
RetryRepeatWraps a node with retry logic.

Variables

Nodes communicate through variables. Each node writes its output to a named variable that downstream nodes reference with ${variable_name} syntax.

SyntaxExample
${var}${sales_data}
${var.property}${recommendations.response}
${var[0]}${customers[0].name}

Execution Trace Panel

When running a workflow, the Trace Panel shows:

  • Real-time node execution status (pending, running, completed, failed)
  • Output values for each completed node
  • Token usage per LLM call
  • Total execution time and resource consumption

Import & Export

Export

Click Export in the agent toolbar to download the complete agent specification as a JSON file. The export includes:

  • All configuration tabs (identity, capabilities, behavior, safety, etc.)
  • The complete workflow graph (nodes, edges, variables)
  • Guard rails and policy settings

Import

Click Import (or New Agent > Import) to upload a JSON specification file. The system validates the specification and creates the agent. You can also import via the addAgent API endpoint.


Next Steps

  • Agent Builder -- Detailed reference for agent specification fields.
  • Workflow Builder -- Deep dive into workflow node types, edges, and error strategies.
  • Agent Catalog -- Browse and run agents from the catalog.
  • Tutorials -- Hands-on tutorials for building your first agent.