Create and manage AI tasks

AI Task: A reusable definition of an AI operation with its own configuration

Output Fields: The structured data you want the AI to return

Published Task: A task that is ready to be executed

Dynamic SmartObject: A task that has been published becomes available as a SmartObject you can call

Schema enforcement controls how strictly the AI must follow your output field definition. Choose the mode that matches your requirements.

It returns the AI's raw text response without any validation or structure requirements.

None

Use it when:

• You only need the raw text response
• You don't need structured data
• The AI's response format is unpredictable

What you get:

• ResponseContent property contains the full AI response
• No output fields are validated

ResponseFormat

What it does:

• Tells the AI API to return structured JSON that matches your schema.
• The API enforces the format before returning the response.

When to use:

• Your AI provider supports structured outputs (OpenAI)
• You want the API to guarantee the response structure
• You need reliable structured data

What you get:

• Response is guaranteed to match your schema
• Output fields are populated from the validated response
• Most reliable option for compatible providers

PromptInjection

What it does:
Embeds your schema requirements directly into the system prompt sent to the AI. The AI is instructed to return JSON matching your schema.

When to use:

• Your AI provider does not support structured outputs
• You want some structure but can tolerate occasional deviations
• You need compatibility with older or different AI models

What you get:

• System prompt includes schema instructions
• Best-effort structure enforcement
• AI may occasionally return non-JSON or mismatched schema

Both

What it does:
Uses both ResponseFormat (if supported) and PromptInjection together for maximum compliance.

When to use:

• You want the highest chance of correct structure
• Your provider supports ResponseFormat
• You want a fallback to prompt-based enforcement

What you get:

• Schema enforced at API level and in prompt
• Best available enforcement
• Maximum reliability

The service can automatically clean user input before sending it to the AI. This is controlled by the SanitizeUserMessage setting on each task.

What gets sanitized

When enabled, user messages go through a cleaning process that:

• Removes control characters that could cause issues
• Normalizes Unicode characters (fancy quotes become regular quotes, em-dashes become hyphens)
• Removes zero-width characters and other invisible text
• Checks for potential injection attempts (SQL, script injection)

When to enable it

Enable sanitisation when:

• User input comes from external sources and it is a concern (forms, emails, documents)
• You want consistent, predictable text going to the AI (In some cases accuracy can drop depending on the task and the input text, but security concerns override this)
• Security is a concern (always a good idea for production!)

You can leave it disabled when:

• You need to preserve exact formatting (code snippets, special characters)
• Your input is already trusted/controlled
• You have your own sanitisation in your workflow

How to enable

Set SanitizeUserMessage to Yes when creating or updating a task. It's optional and defaults to disabled.

• Issue:
  Task not found.
  Cause:
  Task ID incorrect or task not published.
  Resolution:
  Verify the TaskId and check the publication status.
• Issue:
  Schema validation failed.
  Cause:
  AI response missing required fields.
  Resolution:
  Check the system prompt, adjust the schema enforcement.
• Issue:
  Invalid JSON response.
  Cause:
  AI returned non-JSON content.
  Resolution:
  Use PromptInjection or Both modes.
• Issue:
  Configuration error.
  Cause:
  Missing API URL or key.
  Resolution:
  Check the service configuration.
• Issue:
  Task not appearing.
  Cause:
  Service not refreshed after publishing.
  Resolution:
  Refresh the service instance.