# Import Help Center from Crawl

We provide two Import options which both revolve around extracting images from your Help Center. The first option is to **crawl** your Help Center and return a JSON response with all the images and their support article relationships. This is a great way to get started with the API, without requiring any authenticated access. All you need is a URL to your Help Center.

You could consider this option as a **dry-run** of the import process. You can use this to get a feel for the API and the data that will be returned. It could conceptually be used for competitive intelligence as well.

## Create an import job

`POST /helpcenter/import`

### Request

##### Data constraints

A valid `url` is required as JSON Payload.

```
{
    "url": "https://marideal.zendesk.com"
}
```

##### Options related to storing the screenshots in Amazon S3

```
{
...
  "cloud":  {
        "upload": "s3",
        "path": "vidmob/uploads"
    }
}
```

| Fields (optional) | Value | Description |
| --- | --- | --- |
| cloud.upload | `s3` | Save images to Amazon S3 bucket |
| cloud.path | `screenshots/uploads` | Sets the S3 path, including subdirectories |

If you would like to save the imported images in your own S3 bucket, please email us at [hello@launchbrightly.com](mailto:hello@launchbrightly.com) with the S3 access key, S3 secret key, and S3 bucket name, and we will gladly configure the storage with your set of credentials.

Using your own S3 bucket gives you complete control over your images. You can implement your own deletion policies and have full control over how or when they can be accessed.

### Success Response

##### Condition: If everything is OK

##### Code: `202`

##### Content Example:

```
{
  "import_job_id": "5592eac6-dfaf-47b8-890a-b6d7cdd7b0ac",
  "platform": "Zendesk",
  "message": "Your import request has been received successfully"
}
```

### Error Response(s)

##### Condition: If validation fails e.g `url` is invalid or missing

##### Code: `422`

##### Content Example:

```
{
  "errors": ["The URL entered is invalid."]
}
```

### OR

##### Condition: A URL that is not in our list of supported platform

##### Code: `501`

##### Content Example:

```
{
  "message": "We are unable to detect this Help Center platform."
}
```

### OR

##### Condition: If the Help Center is blocked by Cloudflare

##### Code: `403`

##### Content Example:

```
{
  "message": "This Help Center is blocked by Cloudflare. Please try again later.",
  "code": "CLOUDFLARE_BLOCKED"
}
```

### OR

##### Condition: Any other errors

##### Code: `500`

##### Content Example:

```
{
  "message": "An error occurred while processing your request."
}
```

### cURL example:

```
curl --location 'https://api.launchbrightly.com/helpcenter/import' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://marideal.zendesk.com",
    "cloud":  {
        "upload": "s3",
        "path": "screenshots/uploads"
    }
}'
```

## Check an Import Progress

`GET /helpcenter/import/:import_job_id`

### Request

##### Data constraints

A valid `:import_job_id` is required.

###### Optional parameter:

By default, the response will be a list of images with their corresponding images. You can change the default output by appending a query string with the name `dimension`. For example:

`GET /helpcenter/import/:import_job_id?dimension=articles`

Supported values: `articles` or `images` (default)

| dimensions | Description |
| --- | --- |
| images | Display a list of images with their corresponding articles |
| articles | Display a list of articles with their corresponding images |

### Success Response

##### Condition: If everything is OK

##### Code: `200`

##### Content Example (dimension=articles):

```
{
  "id": "05364d66-90ee-45b8-a04f-9eb539fa9ff6",
  "name": "Helpjuice Import",
  "summary": {
    "total": 2,
    "success": 2,
    "pending": 0,
    "failed": 0,
    "skipped": 0
  },
  "total": {
    "articles": {
      "discovered": 2,
      "processed": 2,
      "total": 2,
      "success": 2,
      "pending": 0,
      "failed": 0,
      "skipped": 0
    },
    "images": {
      "total": 2,
      "unique": 2,
      "duplicate": 0
    },
    "authors": 0
  },
  "articles": [
    {
      "id": "08b08d8e-568c-49fa-9ade-2ff15de3518f",
      "external_article_id": "3844212",
      "kbid": "3844212",
      "title": "Launchbrightly Glossary",
      "isPublished": true,
      "url": "https://launchbrightly.helpjuice.com/launchbrightly-glossary",
      "status": "completed",
      "images": [],
      "tags": [],
      "content": "<article id=\"glossary-article\" contenteditable=\"false\">...",
      "createdAt": "2026-06-12T11:46:07.097Z",
      "updatedAt": "2026-06-12T11:46:12.714Z"
    },
    {
      "id": "5f842bde-6e3b-42ae-ad46-250507436f6b",
      "external_article_id": "3844211",
      "kbid": "3844211",
      "title": "How to Maximize Your Helpjuice Experience",
      "isPublished": true,
      "url": "https://launchbrightly.helpjuice.com/how-to-maximize-your-helpjuice-experience",
      "status": "completed",
      "images": [
        {
          "url": "https://static.helpjuice.com/helpjuice_production/uploads/upload/image/34907/direct/1781098199552/billing.png",
          "cloud": {
            "upload": "s3",
            "fileObject": "public/your-help-center-import/imported-billing.png",
            "bucket": "your-bucket-name"
          },
          "name": "billing.png",
          "alt": "",
          "type": "png",
          "width": 890,
          "height": 1444,
          "statusCode": 200,
          "size": 52913,
          "hash": "056ea60c9dcdfebcfcf22288aa5ec44a5dee4e8e638293be6f9c391f151dd5e4",
          "metadata": {}
        }
      ],
      "tags": [],
      "content": "<p>Welcome to Helpjuice! This article will guide you through the features available...</p>",
      "createdAt": "2026-06-12T11:46:07.171Z",
      "updatedAt": "2026-06-12T11:46:18.056Z"
    }
  ]
}
```

##### Content Example (dimension=images):

```
{
  "id": "05364d66-90ee-45b8-a04f-9eb539fa9ff6",
  "name": "Helpjuice Import",
  "summary": {
    "total": 2,
    "success": 2,
    "pending": 0,
    "failed": 0,
    "skipped": 0
  },
  "total": {
    "articles": {
      "discovered": 2,
      "processed": 2,
      "total": 2,
      "success": 2,
      "pending": 0,
      "failed": 0,
      "skipped": 0
    },
    "images": {
      "total": 2,
      "unique": 2,
      "duplicate": 0
    },
    "authors": 0
  },
  "images": [
    {
      "url": "https://static.helpjuice.com/helpjuice_production/uploads/upload/image/34907/direct/1781098199552/billing.png",
      "cloud": {
        "upload": "s3",
        "fileObject": "public/your-help-center-import/imported-billing.png",
        "bucket": "your-bucket-name"
      },
      "name": "billing.png",
      "alt": "",
      "type": "png",
      "width": 890,
      "height": 1444,
      "statusCode": 200,
      "size": 52913,
      "hash": "056ea60c9dcdfebcfcf22288aa5ec44a5dee4e8e638293be6f9c391f151dd5e4",
      "tags": [],
      "metadata": {},
      "articlesCount": 1,
      "articles": [
        {
          "kbid": "3844211",
          "external_article_id": "3844211",
          "url": "https://launchbrightly.helpjuice.com/how-to-maximize-your-helpjuice-experience",
          "title": "How to Maximize Your Helpjuice Experience",
          "isPublished": true
        }
      ]
    }
  ]
}
```

### Error Response(s)

##### Condition: If the import job id is invalid or does not exist

##### Code: `404`

##### Content Example:

```
{
  "message": "The record 05364d66-90ee-45b8-a04f-9eb539fa0000 does not exist or is invalid.",
  "statusCode": 404,
  "error": {
    "message": "The ImportRequest id could not be found: 05364d66-90ee-45b8-a04f-9eb539fa0000",
    "type": "RESOURCE_NOT_FOUND"
  }
}
```

### cURL Examples

```
curl --location --request GET 'https://api.launchbrightly.com/helpcenter/import/:import_job_id?dimension=articles' \
--header 'x-api-key: YOUR_API_KEY'
```

```
curl --location --request GET 'https://api.launchbrightly.com/helpcenter/import/:import_job_id?dimension=images' \
--header 'x-api-key: YOUR_API_KEY'
```