Create a project import job
POST
/v1/project-import-jobscurl -X POST 'https://api.embodiflow.io/v1/project-import-jobs' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT' \
-H 'Content-Type: application/json' \
-d '{
"projectId": "string",
"importSourceId": "string",
"bucketName": "string",
"prefix": "string",
"region": "string",
"provider": "string",
"conflictPolicy": "string",
"credentials": {
"accessKeyId": "string",
"secretAccessKey": "string"
}
}'Authorization
Send a personal access token with every request.
- Authorization: Bearer PAT
Header parameters
- Idempotency-Keystring
Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.
Request body
Content-Typeapplication/json
- projectIdstringrequired
- importSourceIdstring | null
- bucketNamestringrequired
- prefixstring
- regionstring | null
- providerstring
- conflictPolicystring
- credentialsobjectrequired
- accessKeyIdstringrequired
- secretAccessKeystringrequired
Responses
Success
- dataobjectrequired
- idstringrequired
- projectIdstringrequired
- importSourceIdstring | nullrequired
- statusstringrequired
- conflictPolicystringrequired
- datasetIdstring | nullrequired
- summaryobjectrequired
- errorMessagestring | nullrequired
- startedAtstring | nullrequired
- finishedAtstring | nullrequired
- createdAtstringrequired
- updatedAtstringrequired
Response example
{
"data": {
"id": "string",
"projectId": "string",
"importSourceId": "string",
"status": "string",
"conflictPolicy": "string",
"datasetId": "string",
"summary": {
"scannedObjectCount": 0,
"importedObjectCount": 0,
"skippedExistingCount": 0,
"failedCount": 0
},
"errorMessage": "string",
"startedAt": "string",
"finishedAt": "string",
"createdAt": "string",
"updatedAt": "string"
}
}Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1