Start importing a knowledge base bundle produced by an export. The response carries signed transfer instructions for the archive; once its bytes are uploaded, complete the import to create the knowledge base. Bundles must be .zip archives of at most 5 GiB.
OAuth scope: api:write.
POST
/api/v2/knowledge/importsX-API-Key<token>
Send a personal or workspace API key in X-API-Key. See key types and access; operations that reject workspace keys say so in their description.
In: header
Request examples use an API key. For OAuth, replace the X-API-Key header with Authorization: Bearer YOUR_ACCESS_TOKEN.
curl -X POST "https://www.sim.ai/api/v2/knowledge/imports" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64", "name": "Product Documentation", "source": { "type": "upload", "name": "product-documentation.simkb.zip", "contentType": "application/zip", "size": 7340032 } }'const body = JSON.stringify({ "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64", "name": "Product Documentation", "source": { "type": "upload", "name": "product-documentation.simkb.zip", "contentType": "application/zip", "size": 7340032 }})fetch("https://www.sim.ai/api/v2/knowledge/imports", { method: "POST", headers: { "Content-Type": "application/json", "X-API-Key": "YOUR_API_KEY" }, body})package mainimport ( "fmt" "net/http" "io/ioutil" "strings")func main() { url := "https://www.sim.ai/api/v2/knowledge/imports" body := strings.NewReader(`{ "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64", "name": "Product Documentation", "source": { "type": "upload", "name": "product-documentation.simkb.zip", "contentType": "application/zip", "size": 7340032 } }`) req, _ := http.NewRequest("POST", url, body) req.Header.Add("X-API-Key", "YOUR_API_KEY") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body))}import requestsurl = "https://www.sim.ai/api/v2/knowledge/imports"body = """{ "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64", "name": "Product Documentation", "source": { "type": "upload", "name": "product-documentation.simkb.zip", "contentType": "application/zip", "size": 7340032 }}"""response = requests.request("POST", url, data = body, headers = { "Content-Type": "application/json", "X-API-Key": "YOUR_API_KEY"})print(response.text)import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofString("""{ "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64", "name": "Product Documentation", "source": { "type": "upload", "name": "product-documentation.simkb.zip", "contentType": "application/zip", "size": 7340032 }}""");HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://www.sim.ai/api/v2/knowledge/imports")) .header("X-API-Key", "YOUR_API_KEY") .header("Content-Type", "application/json") .POST(body) .build();try { HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString()); System.out.println("Status code: " + response.statusCode()); System.out.println("Response body: " + response.body());} catch (Exception e) { e.printStackTrace();}using System;using System.Net.Http;using System.Text;var body = new StringContent("""{ "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64", "name": "Product Documentation", "source": { "type": "upload", "name": "product-documentation.simkb.zip", "contentType": "application/zip", "size": 7340032 }}""", Encoding.UTF8, "application/json");var client = new HttpClient();client.DefaultRequestHeaders.Add("X-API-Key", "YOUR_API_KEY");var response = await client.PostAsync("https://www.sim.ai/api/v2/knowledge/imports", body);var responseBody = await response.Content.ReadAsStringAsync();{
"data": {
"session": {
"id": "string",
"workspaceId": "string",
"status": "uploading",
"knowledgeBaseId": "string",
"documentsTotal": 0,
"documentsImported": 0,
"documentsFailed": 0,
"vectorsReused": true,
"failures": [
{
"filename": "string",
"message": "string"
}
],
"error": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z"
},
"uploadToken": "string",
"transfer": {
"method": "put",
"url": "http://example.com",
"headers": {
"property1": "string",
"property2": "string"
},
"expiresAt": "2019-08-24T14:15:22Z"
}
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required"
}
}{
"error": {
"code": "USAGE_LIMIT_EXCEEDED",
"message": "Usage limit exceeded. Please upgrade your plan to continue."
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Insufficient workspace permissions",
"details": {
"code": "INSUFFICIENT_WORKSPACE_ROLE"
}
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Not found"
}
}{
"error": {
"code": "PAYLOAD_TOO_LARGE",
"message": "Request body is too large"
}
}{
"error": {
"code": "UNSUPPORTED_MEDIA_TYPE",
"message": "Request body must be sent as application/json"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "API rate limit exceeded",
"details": {
"retryAfter": "2026-01-01T00:00:30.000Z"
}
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error"
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "Service temporarily unavailable"
}
}Request body
application/json
Workspace, bundle archive, and an optional name for the new knowledge base.
TypeScript definitions
Use the request body type in TypeScript.
Response body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json