Import / Export API · imports
Queue the import
POST /imports/{jobId}/commit
Returns 202 with the job id; the work runs in the background under the committer's grant, applying each row as an ordinary command to the owning service. Appends import.queued, which freezes the job's target and mapping. Progress arrives as import.progressed and finishes with import.completed or import.failed. Idempotent by state: a retried commit of a queued job is acknowledged and appends nothing, and 409 ImportNotReady answers a running or finished one.
Access
Requires imports:write.
How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.
Retries
Idempotent by state: a retried commit of a queued job is acknowledged and appends nothing, and 409 ImportNotReady answers a running or finished one.
Why every write carries a key: Idempotency and retries.
Facts appended
import.queuedimport.progressedimport.completedimport.failed
What a fact is: Facts and the journal.
AI agent tool
Agents call this as imports_commit_job (Imports: Commit job), in the imports toolset.
Connecting an agent: AI agents.
Example
curl -X POST 'https://import.getmanifold.io/imports/imp_01a15890-2c00-7a11-8b22-3c4d5e6f7a80/commit' \
-H "Authorization: Bearer $MANIFOLD_TOKEN"const response = await fetch("https://import.getmanifold.io/imports/imp_01a15890-2c00-7a11-8b22-3c4d5e6f7a80/commit", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}` },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();{
"jobId": "imp_01a15890-2c00-7a11-8b22-3c4d5e6f7a80",
"rows": 4
}The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web
page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: import-export.openapi.json. Base URL https://import.getmanifold.io.
Errors
Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing. Some can answer a retry of a call that already worked: they are marked.
401
| Refusal | What it means | What to do |
|---|---|---|
Unauthorized reason | The token is missing, expired or not one Manifold issued. | Get a fresh token and send the call again. |
TokenAlreadyUsed tokenId | A single-use app token was already spent. | Mint a new token for this call. |
402
| Refusal | What it means | What to do |
|---|---|---|
SubscriptionRequired status | The organization's subscription has lapsed, so writes are refused. | An owner settles billing. Reads still work meanwhile. |
403
| Refusal | What it means | What to do |
|---|---|---|
TenantRequired userId | The token names no organization. | Choose the organization, then get a new token. |
ScopeRequired required | The token's roles do not grant the scope this call needs. | Ask an owner or admin for a role that grants it. |
404
| Refusal | What it means | What to do |
|---|---|---|
ImportJobNotFound jobId | No such record in this organization. | Check the id in the path or the body. |
409
| Refusal | What it means | What to do |
|---|---|---|
ImportNotReady jobId, status, expected Can answer a retry | The import is not in a state this call accepts. | If this answers a retry, your first call probably landed. Read the record: its status says where it stands, and expected the states this call accepts. |
MirroredFromSource source | This area is fed by your source system until the organization goes live. | Make the change in the source system, or go live first. |
422
| Refusal | What it means | What to do |
|---|---|---|
InvalidMapping reason, field | The column mapping does not fit the target. field names the problem. | Map every required field once. |
503
| Refusal | What it means | What to do |
|---|---|---|
RequestLogUnavailable tokenId, reason | The service could not record the request, so it did nothing. | Send the same request again shortly. |
How refusals work everywhere: Errors.
Used in
- Bulk import from a spreadsheet, step 5: Run it