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

# List Rescan Agents

Use this API to list the agents to run to rescan a project's site: the agents of its checks and of its runs in the last 30 days, so a site whose agents found nothing still names them. With `pages`, only the agents that checked one of those pages. When no agent checked any of them, every agent of the site is returned.

Run the agents with [Run Execution](https://velt.dev/docs/api-reference/rest-apis/v2/agents/execution/run.md). This endpoint starts nothing and charges nothing.

# Endpoint

`POST https://api.velt.dev/v2/agents/checks/rescan-agents/list`

# Headers

**x-velt-api-key** `string` *required*

Your API key.

**x-velt-auth-token** `string` *required*

Your [Auth Token](https://velt.dev/docs/security/auth-tokens.md).

# Body

#### Params

**data** `object` *required*

**properties**

**organizationId** `string` *required*

1 to 512 characters. The organization of the project.

**documentId** `string` *required*

1 to 512 characters. The document of the project.

**pages** `string[]`

At most 1,000 absolute `http(s)` page URLs, each at most 2,048 characters. Without it, the agents of the whole site.

The schema uses `.strict()`: unknown fields are rejected.

## **Example Requests**

#### 1. The whole site

```JSON theme={null}
{
  "data": {
    "organizationId": "org_acme",
    "documentId": "acme-marketing-site"
  }
}
```

#### 2. Some pages

```JSON theme={null}
{
  "data": {
    "organizationId": "org_acme",
    "documentId": "acme-marketing-site",
    "pages": [
      "https://www.example.com/pricing",
      "https://www.example.com/about"
    ]
  }
}
```

# Response

#### Success Response

```JSON theme={null}
{
  "result": {
    "status": "success",
    "message": "Rescan agents retrieved",
    "data": {
      "agentIds": ["broken-links", "spell-check"]
    }
  }
}
```

| Field | Type | Description |
| - | - | - |
| `data.agentIds` | string\[] | The agent ids, sorted. Empty when no agent has checked the site. |

#### Failure Response

```JSON theme={null}
{
  "error": {
    "message": "pages must be a list of page URLs",
    "status": "INVALID_ARGUMENT",
    "details": {
      "reason": "CHECKS_INVALID_PAGES"
    }
  }
}
```

**Errors:** `INVALID_ARGUMENT` (a body outside the schema: a `pages` entry that is not a URL, more than 1,000 `pages`, or an unknown field; or `CHECKS_INVALID_PAGES` for a `pages` entry that is not `http(s)`) / `NOT_FOUND` with `CHECKS_WORKSPACE_NOT_FOUND` (the workspace has no store database).

```js theme={null}
{
  "result": {
    "status": "success",
    "message": "Rescan agents retrieved",
    "data": {
      "agentIds": ["broken-links"]
    }
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.