---
updatedAt: 2026-05-20T10:55:26.000Z
agentTools:
  projectIndex: https://docs.makaira.io/llms.txt
---

# RPC importer call

Trigger full imports via API, needs importer[importerid]="source target" setting in customer config

Sends an RPC command to the importer. This is the core endpoint for triggering import operations such as starting a full or delta import for one or more document types.

Requires the `importer:write` or `importer.write` permission.

## Request

**`POST /importer/`**

### Headers

| Header          | Value              |
| --------------- | ------------------ |
| `Authorization` | `Bearer <token>`   |
| `Content-Type`  | `application/json` |

### Request Body

| Field       | Type   | Required | Description                                                                    |
| ----------- | ------ | -------- | ------------------------------------------------------------------------------ |
| `command`   | string | Yes      | The RPC command to execute (e.g. `"import"`, `"importFull"`, `"importDelta"`). |
| `arguments` | object | Yes      | Arguments for the command. Content depends on the command.                     |

### Example Request

```json
{
  "command": "importFull",
  "arguments": {
    "types": ["product", "category"],
    "language": "de"
  }
}
```

## Response

Returns the result of the RPC command on success, or an error payload with the appropriate HTTP status code on failure.

### Example Response

```json
{
  "ok": true
}
```

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Makaira API",
    "version": "1.0",
    "contact": {
      "name": "Makaira GmbH",
      "url": "https://www.makaira.io/",
      "email": "support@makaira.io"
    },
    "description": "API of the powerful Makaira Search/Recommendation and Marketing Suite"
  },
  "servers": [
    {
      "url": "https://{yourinstance}.makaira.io"
    }
  ],
  "paths": {
    "/importer/{importerid}/start": {
      "post": {
        "summary": "",
        "tags": [
          "Importer"
        ],
        "operationId": "importer-start",
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "parameters": [
          {
            "name": "importerid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "$ref": "#/components/parameters/instance"
          }
        ],
        "description": "Trigger full imports via API, needs importer[importerid]=\"source target\" setting in customer config"
      }
    }
  },
  "components": {
    "parameters": {
      "instance": {
        "in": "header",
        "name": "X-Makaira-Instance",
        "required": true,
        "description": "Makaira Instance ID",
        "schema": {
          "type": "string"
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Authentication by JSON Web Token\n"
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```