Skip to content
Try for free
On this page

Knowledge bases

Complete knowledge base import upload

Verify the uploaded bundle and start creating the knowledge base under the same import ID. Vectors are reused when the bundle was embedded with this deployment's model; otherwise documents are re-indexed. Completion records an audit event. Repeating it returns the running import. OAuth scope: `api:write`.

POST/api/v2/knowledge/imports/{importId}/complete

Verify the uploaded bundle and start creating the knowledge base under the same import ID. Vectors are reused when the bundle was embedded with this deployment's model; otherwise documents are re-indexed. Completion records an audit event. Repeating it returns the running import.

OAuth scope: api:write.

Authentication

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.

Send X-API-Key in the request header.

Alternatively

Send a Sim OAuth access token in Authorization: Bearer. See OAuth authentication and scopes.

Authorization: Bearer YOUR_ACCESS_TOKEN

Required scopes: api:write

OAuth flows
json
{
  "authorizationCode": {
    "authorizationUrl": "https://www.sim.ai/api/auth/oauth2/authorize",
    "tokenUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "refreshUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "scopes": {
      "api:read": "Read your workspaces, workflows, files, tables, and logs",
      "api:write": "Read, create, change, run, and delete resources in your workspaces",
      "offline_access": "Stay signed in without asking again"
    }
  }
}

OAuth scope: api:write.

Path parameters

importIdstringRequired

Unique knowledge-base import identifier.

minLength
1

Query parameters

workspaceIdstringRequired

Workspace that owns the import.

minLength
1
maxLength
128

Header parameters

upload-tokenstringRequired

Signed upload control token returned when the upload session was created.

minLength
1

Responses

200

The knowledge base import after its upload completed.

object

The import lifecycle resource once processing has started.

1 field
dataobjectRequired

Response data.

13 fields
idstringRequired

Unique knowledge-base import identifier.

workspaceIdstringRequired

Workspace that owns the import.

statusstringRequired

Current import lifecycle state.

enum
["uploading","processing","completed","failed","canceled","expired"]
knowledgeBaseIdvalueRequired

Knowledge base the import created, or null until it exists.

Schema details

Any of

Option 1string
Option 2null
documentsTotalintegerRequired

Documents the bundle carries; zero until its manifest has been read.

minimum
0
maximum
9007199254740991
documentsImportedintegerRequired

Documents created so far. A document whose vectors could not be reused is indexed afterwards, as an upload is, so it may still be processing in the knowledge base.

minimum
0
maximum
9007199254740991
documentsFailedintegerRequired

Documents that could not be imported. Non-zero still allows completed.

minimum
0
maximum
9007199254740991
vectorsReusedbooleanRequired

Whether the bundle's vectors matched this deployment's embedding model and were stored without re-embedding.

failuresarrayRequired

Bounded sample of the documents that could not be imported.

Schema details
Array itemobject

One bundle document the import could not bring over.

2 fields
filenamestringRequired

Filename of the document that was not imported.

messagestringRequired

Why the document was not imported.

Additional properties are not allowed.

errorvalueRequired

Terminal failure reason, or null.

Schema details

Any of

Option 1string
Option 2null
createdAtstringRequired

ISO 8601 creation timestamp.

format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
updatedAtstringRequired

ISO 8601 last-update timestamp.

format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
completedAtvalueRequired

ISO 8601 completion timestamp, or null.

Schema details

Any of

Option 1string
format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Option 2null

Additional properties are not allowed.

Additional properties are not allowed.

Response headers

X-RateLimit-Limitinteger

Maximum requests allowed in the current window.

minimum
0
maximum
9007199254740991
X-RateLimit-Remaininginteger

Requests remaining in the current window.

minimum
0
maximum
9007199254740991
X-RateLimit-Resetstring

ISO 8601 timestamp when the current rate-limit window resets.

format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Was this helpful?
Suggest an edit