Quickstart Ruby

​

Prerequisites

You'll need an API key to use the Moderation API. To get one, you'll need to create a project.

• Create a project

​

1. Install the SDK

gem install moderation_api

​

2. Submit content

Grab the API key from your project and begin submitting text, images, or other media to your project for moderation.

require 'moderation_api'

# Configure your client using an environment variable for the API key
ModerationApi.configure do |config|
  config.access_token = ENV['API_KEY']
end

api = ModerationApi::ModerateApi.new

# Text moderation
text_request = ModerationApi::ModerationTextRequest.new(
  value: "Hello world!",
  author_id: "123",
  context_id: "456",
  metadata: {
    custom_field: "value"
  }
)

begin
  text_analysis = api.moderation_text(text_request)

  if text_analysis.flagged
    puts "Text content flagged"
    # Block the content, show an error, etc...
  else
    puts "Text content is safe."
    # Save to database or proceed...
  end
rescue ModerationApi::ApiError => e
  puts "Error when calling ModerateApi->moderation_text: #{e}"
end

Dry-run mode: If you want to analyze production data but don't want to block content, enable "dry-run" in your project settings.

With dry-run enabled, the API still analyzes content but it always returns flagged: false - yet content still shows in the review queue. This way you can implement your moderation workflows and start testing your project configuration without actually blocking content.

​

3. Review flagged content (optional)

If the AI flags the content, it will appear in the Review Queue.

Head to the review queue to validate that the content is submitted correctly.

You can use review queues to implement moderation workflows or simply check how the AI is performing.

​

All Done!

Congratulations! You've run your first moderation checks. Here are a few next steps:

• Continue tweaking your project settings and models to find the best moderation outcomes.
• Create an AI agent and add your guidelines to it.
• Explore advanced features like context-aware moderation.
• If you have questions, reach out to our support team.

We love hearing from you—please share how you're using the service and let us know if you have suggestions or need help. Happy moderating!