Create a onboarding sample
POST
/v1/onboarding-samplescurl -X POST 'https://api.embodiflow.io/v1/onboarding-samples' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT'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.
Responses
Success
- dataobjectrequired
- idstringrequired
- projectIdstring | nullrequired
- templateIdstringrequired
- templateVersionstringrequired
- statusstringrequiredAllowed valuesfailedreadyprovisioningdeleted
- errorCodestring | nullrequiredAllowed valuesSAMPLE_TEMPLATE_UNAVAILABLESAMPLE_PROJECT_READ_ONLYSAMPLE_PROVISION_FORBIDDENSAMPLE_NOT_FOUND
- createdAtstringrequired
- updatedAtstringrequired
Response example
{
"data": {
"id": "string",
"projectId": "string",
"templateId": "string",
"templateVersion": "string",
"status": "failed",
"errorCode": "SAMPLE_TEMPLATE_UNAVAILABLE",
"createdAt": "string",
"updatedAt": "string"
}
}Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1