> ## Documentation Index
> Fetch the complete documentation index at: https://koreai.mintlify.app/llms.txt
> Use this file to discover all available pages before exploring further.

# TestRail Connector

<Badge icon="arrow-left" color="gray">[Back to Search AI connectors list](/ai-for-service/searchai/content-sources#supported-connectors)</Badge>

TestRail is a test management tool for creating, organizing, and tracking test cases, runs, and results. The TestRail Connector enables Search AI to ingest test cases from TestRail so QA teams can search them alongside other organizational content.

## Specifications

| Specification     | Details    |
| ----------------- | ---------- |
| Repository type   | Cloud      |
| Supported content | Test cases |
| RACL support      | Yes        |
| Content filtering | No         |

## Connector Configuration

Search AI interacts with TestRail through its APIs. API communication requires an API token to authenticate requests.

### Generate an API Token in TestRail

1. Log in to your TestRail instance.
2. Click your profile name in the top-right corner and select **My Settings**.
3. Go to the **API Keys** tab.
4. Enter a name for the key and click **Generate Key**.
5. Copy the generated API key.

### Configure the Connector in Search AI

On the **Authorization** tab of the connector, provide the following details and click **Connect**:

| Field        | Description                                |
| ------------ | ------------------------------------------ |
| **Name**     | Unique name for the connector              |
| **Domain**   | URL of your TestRail instance              |
| **Username** | Username of the account used for ingestion |
| **API Key**  | API key generated in TestRail              |

## Content Ingestion

After connecting, go to the **Configuration** tab and click **Sync Now** to begin ingestion. Use the **Scheduler** to set up a one-time or recurring sync.

The connector retrieves all test cases across every project in the connected TestRail instance. Each test case is ingested as a separate document with the following fields:

| Field            | Description                                                                                              |
| ---------------- | -------------------------------------------------------------------------------------------------------- |
| **Title**        | Title of the test case                                                                                   |
| **URL**          | Direct link to the test case in TestRail                                                                 |
| **Priority**     | Priority level of the test case                                                                          |
| **Content**      | Includes title, preconditions, steps, description, mission, goal, type, milestone, references, and suite |
| **Project ID**   | ID of the project the test case belongs to                                                               |
| **Project Name** | Name of the project the test case belongs to                                                             |

## RACL Support

The TestRail Connector supports project-level access control. For each ingested test case, the `sys_racl` field is set to the Project ID and saved as a permission entity object. Use the **Permission Entity APIs** to associate users with the appropriate Project IDs.