---
title: "Connect"
method: POST
path: "/integrations/semrush/connect"
tags: ["integrations"]
---

# Connect

`POST /integrations/semrush/connect`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/integrations/semrush/connect`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Validate the key against Semrush before storing it, so a typo never reads as connected.

## Headers

- `timezone` string
- `x-user-id` string, nullable
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable
- `organization-id` string, nullable

## Request body

- SemrushConnectRequest
  - `api_key` string, password, required: Semrush v4 API key from My profile > API Keys

## Response `200`

Successful Response

- SemrushConnectionResponse
  - `integration_id` string, required
  - `status` string, required
  - `projects` SemrushProjectResponse[], required
    - `project_id` string, required
    - `name` string, nullable
    - `domain` string, nullable
    - `tools` string[]
  - `projects_listed` boolean
  - `seo_reports` boolean
  - `seo_reports_reason` string, nullable
  - `seo_reports_url` string, nullable
  - `maps_rankings` boolean
  - `map_campaigns` integer, nullable
  - `capabilities` object, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/86e2c2bd93af?raw)