# Roe Documentation

- [Introduction](https://docs.roe-ai.com/introduction.md): Welcome to Roe's Documentation
- [Quickstart](https://docs.roe-ai.com/quickstart.md): Start analyzing your unstructured data in under 5 minutes
- [Introduction](https://docs.roe-ai.com/agents/introduction.md): Start building powerful data processing Agents in under 5 minutes
- [Quickstart](https://docs.roe-ai.com/agents/quickstart.md): Build your first Roe Agent in under 5 minutes
- [Input Definitions](https://docs.roe-ai.com/agents/input-definition.md): Define the inputs that your Agent will accept
- [Prompt Engineering Guide](https://docs.roe-ai.com/agents/prompt-engineering.md): How to create prompts effectively for your Agents
- [JSON Output Schema](https://docs.roe-ai.com/agents/output-schema-json.md): Define the structure of the JSON output
- [Introduction](https://docs.roe-ai.com/agents/engines/introduction.md): Extraction and processing engines for structured data transformation
- [Document Segmentation](https://docs.roe-ai.com/agents/engines/document-segmentation.md): Parses page filter criteria and outputs a list of page ranges from PDF documents.
- [Google Maps Insights](https://docs.roe-ai.com/agents/engines/google-maps.md): Extracts location information, nearby places, and geographic data from Google Maps.
- [Interactive Web Insights](https://docs.roe-ai.com/agents/engines/interactive-web.md): Performs interactive web browsing and extracts information from dynamic web pages.
- [Marketplace Storefront Analysis](https://docs.roe-ai.com/agents/engines/marketplace-storefront.md): Analyzes marketplace storefronts for policy compliance and risk assessment.
- [Merchant Risk Analysis](https://docs.roe-ai.com/agents/engines/merchant-risk.md): Analyzes merchant risk profiles for underwriting and compliance purposes.
- [Multimodal Insights](https://docs.roe-ai.com/agents/engines/multimodal-extraction.md): Extracts insights and structured information from text and images using AI vision models.
- [Document Insights](https://docs.roe-ai.com/agents/engines/pdf-extraction.md): Extracts insights and structured information from PDF documents using AI.
- [Research Agent](https://docs.roe-ai.com/agents/engines/research.md): Performs AI-powered web research to gather and synthesize information on any topic.
- [Social Media Crawler](https://docs.roe-ai.com/agents/engines/social-media-crawler.md): Scrapes profile information and content from social media platforms.
- [Web Insights](https://docs.roe-ai.com/agents/engines/url-extraction.md): Extracts insights and structured information from URLs
- [URL Finder](https://docs.roe-ai.com/agents/engines/url-finder.md): Searches for relevant URLs using text search, reverse image lookup, or both.
- [Introduction](https://docs.roe-ai.com/agents/agentic-workflows/introduction.md): Autonomous AI agents that reason, research, and make decisions
- [AML Investigation](https://docs.roe-ai.com/agents/engines/aml-investigation.md): Investigates transaction data for potential money laundering patterns using policy-driven analysis
- [Data Analysis](https://docs.roe-ai.com/agents/engines/data-analysis.md): Performs AI-powered multimodal data analysis with web research and context source integration.
- [Fraud Investigation](https://docs.roe-ai.com/agents/engines/fraud-investigation.md): Investigates fraud alerts by analyzing transaction data, alert signals, and external intelligence to determine if an alert is genuine fraud or a false positive
- [Merchant Underwriting](https://docs.roe-ai.com/agents/engines/merchant-underwriting.md): Evaluates merchant risk and legitimacy for onboarding decisions using SOP-driven analysis
- [Product Policy](https://docs.roe-ai.com/agents/engines/product-policy.md): Analyzes product listings against policy rules for compliance violations.
- [Introduction](https://docs.roe-ai.com/database/introduction.md): Index, search, and analyze unstructured data with SQL, no matter the scale.
- [Quickstart](https://docs.roe-ai.com/database/quickstart.md): Work with your unstructured data at scale in under 5 minutes
- [Introduction](https://docs.roe-ai.com/database/functions/introduction.md): A set of functions dedicated to working with unstructured data
- [run_agent](https://docs.roe-ai.com/database/functions/run-agent.md): Run an Agent to process unstructured data.
- [run_agent_sync](https://docs.roe-ai.com/database/functions/run-agent-sync.md): Run an Agent to process unstructured data synchronously.
- [job_status](https://docs.roe-ai.com/database/functions/job-status.md): Get the status of an Agent Job.
- [job_result | resolve](https://docs.roe-ai.com/database/functions/job-result.md): Get the result of an Agent Job.
- [keep_pages](https://docs.roe-ai.com/database/functions/keep-pages.md): Select which pages to keep and process in a PDF file.
- [Introduction](https://docs.roe-ai.com/database/examples/introduction.md): SQL workspace usage examples.
- [Introduction](https://docs.roe-ai.com/data-resources/introduction.md): Connect to any data source or manage your data directly on Roe
- [Context Sources](https://docs.roe-ai.com/data-resources/context-sources.md): Configure data sources for agentic workflows
- [Introduction](https://docs.roe-ai.com/data-resources/roe-datasets/introduction.md): Manage your files on Roe
- [Introduction](https://docs.roe-ai.com/data-resources/connectors/introduction.md): Connect to external data sources
- [Custom API Connector](https://docs.roe-ai.com/data-resources/connectors/custom-api.md): Connect any REST API to Roe with configurable authentication and endpoints
- [AWS S3 Connector](https://docs.roe-ai.com/data-resources/connectors/s3.md): Connect AWS S3 to Roe
- [Snowflake Connector](https://docs.roe-ai.com/data-resources/connectors/snowflake.md): Connect Snowflake data warehouse to Roe
- [SharePoint Connector](https://docs.roe-ai.com/data-resources/connectors/sharepoint.md): Connect Microsoft SharePoint to Roe for document access
- [Zendesk Connector](https://docs.roe-ai.com/data-resources/connectors/zendesk.md): Connect Zendesk to Roe for customer support data
- [Policies](https://docs.roe-ai.com/policies/introduction.md): Define structured rulesets and guidelines for your agents
- [Webhooks](https://docs.roe-ai.com/webhooks/introduction.md): Receive real-time notifications when agent jobs complete
- [Introduction](https://docs.roe-ai.com/mcp/introduction.md): Connect ChatGPT, Claude, Claude Code, Codex, and Cursor to Roe over OAuth or a Roe API key
- [Roe MCP Basics](https://docs.roe-ai.com/mcp/skills/roe-mcp-basics.md): Teach your assistant the Roe MCP fundamentals — run-mode selection, job polling, table queries, auth and error handling — with one installable skill
- [Workflow Builder](https://docs.roe-ai.com/mcp/skills/workflow-builder.md): Build complex Roe workflows from Claude Code, Cursor, Codex, and other AI assistants — install one skill and your assistant knows the full authoring contract
- [MCP tools reference](https://docs.roe-ai.com/mcp/tools.md): All tools exposed by the Roe MCP server, with parameters and behavior annotations.
- [OIDC Single Sign-On (SSO) Integration](https://docs.roe-ai.com/enterprise/sso.md): Guide to configuring OIDC SSO for your organization.
- [Microsoft Entra ID (Azure AD) OIDC SSO Integration](https://docs.roe-ai.com/enterprise/sso-entraid.md)
- [Okta OIDC SSO Integration Guide](https://docs.roe-ai.com/enterprise/sso-okta.md)
- [ADFS OIDC SSO Integration Guide](https://docs.roe-ai.com/enterprise/sso-adfs.md)
- [SAML Single Sign-On (SSO) Integration](https://docs.roe-ai.com/enterprise/sso-saml.md): Guide to configuring SAML SSO for your organization.
- [Microsoft Entra ID (Azure AD) SAML SSO Integration](https://docs.roe-ai.com/enterprise/sso-saml-entraid.md)
- [Introduction](https://docs.roe-ai.com/use-cases/finance.md)
- [Release 1.0.97](https://docs.roe-ai.com/release-notes/release-1-0-97.md): Metabase and Google Sheets expand agent access, interactive web browsing upgrades, and connector security hardens.
- [Release 1.0.95](https://docs.roe-ai.com/release-notes/release-1-0-95.md): New browser connectors, approval workflows, fraud monitoring, and model controls across Roe.
- [Release 1.0.94](https://docs.roe-ai.com/release-notes/release-1-0-94.md): Workflow versioning, richer connectors, new models, and reliability improvements across Roe.
- [Release 1.0.93](https://docs.roe-ai.com/release-notes/release-1-0-93.md): Agent management, investigation workflows, and data tooling updates across Roe.
- [Release 1.0.92](https://docs.roe-ai.com/release-notes/release-1-0-92.md): Skills versioning, approval gates, new workflow tools, and reliability improvements across Roe.
- [Release 1.0.91](https://docs.roe-ai.com/release-notes/release-1-0-91.md): New result dashboards, stronger job error handling, expanded file and document workflows, and updated default models.
- [Release 1.0.90](https://docs.roe-ai.com/release-notes/release-1-0-90.md): KYC tooling, workflow inputs, connector runtime configuration, and dashboard updates.
- [Release 1.0.89](https://docs.roe-ai.com/release-notes/release-1-0-89.md): KYC and ID verification upgrades, review mode, and agent workflow improvements.
- [Release 1.0.88](https://docs.roe-ai.com/release-notes/release-1-0-88.md): Browser Use upgrades, new Google Workspace tools, Roe MCP updates, and new GPT-5.6 models.
- [Release 1.0.87](https://docs.roe-ai.com/release-notes/release-1-0-87.md): Browser automation, agent management, and new Google Workspace connectors headline this release.
- [Release 1.0.86](https://docs.roe-ai.com/release-notes/release-1-0-86.md): Policy editing, agent review workflows, pricing controls, and security hardening across Roe.
- [Release 1.0.85](https://docs.roe-ai.com/release-notes/release-1-0-85.md): Faster job views, stronger public API and MCP coverage, and major upgrades to knowledge base and workflow tooling.
- [Release 1.0.84](https://docs.roe-ai.com/release-notes/release-1-0-84.md): Workflow builder upgrades, new MCP and connector capabilities, stronger audit visibility, and reliability improvements across agents and APIs.
- [SDK Overview](https://docs.roe-ai.com/api-reference/sdk-integration.md): Manage your unstructured data with Python, TypeScript, or Go
- [Overview](https://docs.roe-ai.com/api-reference/python-sdk-introduction.md): Official Python SDK for Roe
- [Examples](https://docs.roe-ai.com/api-reference/python-sdk-reference.md): Copy-ready examples for calling Roe with the Python SDK.
- [Use Cases](https://docs.roe-ai.com/api-reference/python-sdk-use-cases.md): End-to-end workflows for calling Roe with the Python SDK.
- [Overview](https://docs.roe-ai.com/api-reference/typescript-sdk-introduction.md): Official TypeScript SDK for Roe
- [Examples](https://docs.roe-ai.com/api-reference/typescript-sdk-reference.md): Copy-ready examples for calling Roe with the TypeScript SDK.
- [Use Cases](https://docs.roe-ai.com/api-reference/typescript-sdk-use-cases.md): End-to-end workflows for calling Roe with the TypeScript SDK.
- [Overview](https://docs.roe-ai.com/api-reference/go-sdk-introduction.md): Official Go SDK for Roe
- [Examples](https://docs.roe-ai.com/api-reference/go-sdk-reference.md): Copy-ready examples for calling Roe with the Go SDK.
- [Use Cases](https://docs.roe-ai.com/api-reference/go-sdk-use-cases.md): End-to-end workflows for calling Roe with the Go SDK.
- [Introduction](https://docs.roe-ai.com/api-reference/introduction.md): Manage your unstructured data with Roe API
- [Examples](https://docs.roe-ai.com/api-reference/examples.md): API Examples
- [List Agents](https://docs.roe-ai.com/api-reference/agents/list-agents.md): Retrieve a list of agents or create a new agent.
- [Create Agent](https://docs.roe-ai.com/api-reference/agents/create-agent.md): Create a new base agent.
- [Retrieve an Agent](https://docs.roe-ai.com/api-reference/agents/retrieve-agent.md): Retrieve details of a specific base agent.
- [Update an Agent's Settings](https://docs.roe-ai.com/api-reference/agents/update-agent-settings.md): Update a base agent's settings.
- [Delete an Agent](https://docs.roe-ai.com/api-reference/agents/delete-agent.md): Delete a specific base agent.
- [Duplicate an Agent](https://docs.roe-ai.com/api-reference/agents/duplicate-agent.md): Create a new agent with the same attributes as the current version of the specified agent.
- [List Agent Versions](https://docs.roe-ai.com/api-reference/agents/list-agent-versions.md): Retrieve a list of versions for a specific agent.
- [Create Agent Version](https://docs.roe-ai.com/api-reference/agents/create-agent-version.md): Create a new version of an existing agent.
- [Retrieve an Agent Version](https://docs.roe-ai.com/api-reference/agents/retrieve-agent-version.md): Retrieve details of a specific agent version.
- [Retrieve Current Agent Version](https://docs.roe-ai.com/api-reference/agents/retrieve-agent-current-version.md): Retrieve details of the current version of a specific agent.
- [Run Agent](https://docs.roe-ai.com/api-reference/agents/run.md): Execute an agent with provided inputs and return results immediately.
- [Run Agent Async](https://docs.roe-ai.com/api-reference/agents/run-async.md): Run agent asynchronously. Returns agent job id which can be used to check status and get results.
- [Agent Job Status](https://docs.roe-ai.com/api-reference/agents/job-status.md): Get agent job status.
- [Agent Job Result](https://docs.roe-ai.com/api-reference/agents/job-result.md): Get agent job result data. If the output references artifact keys (e.g. `evidence_data` values), fetch their full content via GET /v1/agents/jobs/{agent_job_id}/artifacts/result/?artifact_key=<key>.
- [List Agent's Jobs](https://docs.roe-ai.com/api-reference/agents/list-agent-jobs.md): Retrieve a list of jobs for a specific agent or create a new job
- [Run Query](https://docs.roe-ai.com/api-reference/database/query.md): Execute a query synchronously and return results.
- [Run Query Async](https://docs.roe-ai.com/api-reference/database/query-async.md): Execute a query asynchronously and return query object.
- [Query Status](https://docs.roe-ai.com/api-reference/database/query-status.md): Get the status of a query.
- [Query Result](https://docs.roe-ai.com/api-reference/database/query-result.md): Get the results of a query.
- [List Datasets](https://docs.roe-ai.com/api-reference/roe-dataset/list.md): Retrieve a list of datasets or create a new dataset.
- [Create a Dataset](https://docs.roe-ai.com/api-reference/roe-dataset/create.md): Create a new dataset.
- [Delete a Dataset](https://docs.roe-ai.com/api-reference/roe-dataset/delete-dataset.md): Permanently delete a dataset. All associated files are soft-deleted and can be restored later.
- [Upload File](https://docs.roe-ai.com/api-reference/roe-dataset/file-upload.md): Mixin for organization access validation.
- [Download File](https://docs.roe-ai.com/api-reference/roe-dataset/file-download.md): Download a file by its file string identifier.
- [Delete a File](https://docs.roe-ai.com/api-reference/roe-dataset/delete-file.md): Mixin for organization access validation.
- [List Policies](https://docs.roe-ai.com/api-reference/policies/list-policies.md): List all policies and create a new policy
- [Create Policy](https://docs.roe-ai.com/api-reference/policies/create-policy.md): List all policies and create a new policy
- [Retrieve Policy](https://docs.roe-ai.com/api-reference/policies/retrieve-policy.md): Retrieve, update, or delete a single policy by ID
- [Update Policy](https://docs.roe-ai.com/api-reference/policies/update-policy.md): Retrieve, update, or delete a single policy by ID
- [Delete Policy](https://docs.roe-ai.com/api-reference/policies/delete-policy.md): Retrieve, update, or delete a single policy by ID
- [List Policy Versions](https://docs.roe-ai.com/api-reference/policies/list-policy-versions.md): Create a new policy version or list all versions of a specific policy
- [Create Policy Version](https://docs.roe-ai.com/api-reference/policies/create-policy-version.md): Create a new policy version or list all versions of a specific policy
- [Retrieve Policy Version](https://docs.roe-ai.com/api-reference/policies/retrieve-policy-version.md): Get a policy version by ID. Supports two lookup methods: 1. Direct PolicyVersion ID lookup 2. Policy ID lookup using the policy's current_version_id
- [Set Current Version](https://docs.roe-ai.com/api-reference/policies/set-current-version.md): Set the current version of a policy
- [List Webhooks](https://docs.roe-ai.com/api-reference/webhooks/list-webhooks.md): Mixin for organization access validation.
- [Create Webhook](https://docs.roe-ai.com/api-reference/webhooks/create-webhook.md): Mixin for organization access validation.
- [Retrieve Webhook](https://docs.roe-ai.com/api-reference/webhooks/retrieve-webhook.md): Mixin for organization access validation.
- [Update Webhook](https://docs.roe-ai.com/api-reference/webhooks/update-webhook.md): Mixin for organization access validation.
- [Delete Webhook](https://docs.roe-ai.com/api-reference/webhooks/delete-webhook.md): Mixin for organization access validation.
- [List Webhook Agents](https://docs.roe-ai.com/api-reference/webhooks/list-webhook-agents.md): List agents linked to a webhook, or link new agents.
- [Link Agents to Webhook](https://docs.roe-ai.com/api-reference/webhooks/link-agents.md): List agents linked to a webhook, or link new agents.
- [Unlink Agent from Webhook](https://docs.roe-ai.com/api-reference/webhooks/unlink-agent.md): Remove an agent link from a webhook.
- [Introduction](https://docs.roe-ai.com/sql-reference/introduction.md): Manage your unstructured data in Roe with SQL

## OpenAPI Specs

- [openapi](/api-reference/openapi.yml)

## Optional

- [Community](https://join.slack.com/t/roeaiusers/shared_invite/zt-2m0oa9kj4-wltD91LCeJJR~cN1y1R7JQ)
- [Blog](https://roeai.substack.com/)