---
title: "Import Entities"
method: POST
path: "/v1/entity:import"
tags: ["Import-Export"]
---

# Import Entities

`POST /v1/entity:import`

This endpoint enables the import of entities into the platform.
The entities should be provided in a CSV format inside an S3 bucket.
This API will return the `job_id`` which can be used to fetch the status of the import process.

## Query parameters

- `job_id` string — The unique identifier of the import job.

## Request body

- EntityImportParams — The parameters for importing entities.
  - `S3Reference` object, required — The S3 bucket and key where the JSON file for import is located.
    - `bucket` string, required — The name of the S3 bucket where the JSON file for import is stored.
    - `key` string, required — The key or path to the JSON file within the S3 bucket.
  - `schema` string, required — The schema of the entities being imported. This must match the schema of the entities on the platform.

## Response `201`

The import operation was initiated successfully.
The response includes the URLs for the files containing the successful and failed imported entities.

## Other responses

- `429` — Too many requests

---

[API](https://skmtc.net/epilot/apis/entity-api.md) · [All operations](https://skmtc.net/epilot/apis/entity-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/epilot/entity-api/revisions/3020984570dc/schema)