Skip to main content
PATCH
/
api
/
data-platform
/
spec-recommendation-runs
/
{id}
curl --request PATCH \
  --url https://app.solya.app/api/data-platform/spec-recommendation-runs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "databricksRunId": "dbr-run-99887766",
  "errorMessage": "Could not detect file encoding: file appears to be binary",
  "organizationId": "org-uuid-1234",
  "status": "FAILED"
}
'
{
  "completedAt": "2026-05-23T09:00:44.000Z",
  "id": "run-uuid-sr-7f3a2b",
  "startedAt": "2026-05-23T09:00:02.000Z",
  "status": "SUCCESS"
}

Authorizations

Authorization
string
header
required

Static internal-ops token used by the data platform and internal cron jobs (e.g. zombie-run sweep). Validated via requireBearerToken inside the handler against a service-specific environment variable.

Path Parameters

id
string
required

UUID of the spec recommendation run to update

Minimum string length: 1

Body

application/json
organizationId
string
required

Organization UUID for tenant isolation

Minimum string length: 1
status
enum<string>
required

New status for the run

Available options:
PENDING,
RUNNING,
SUCCESS,
FAILED
databricksRunId
string

Databricks job run ID for cross-system correlation

errorMessage
string

Human-readable error detail; provide when status=FAILED

previews
object[] | null

Per-dataset conformed row previews; populated alongside recommendedSpec when status=SUCCESS; null to clear

Recommended ingestion spec sections; populated when status=SUCCESS; null to clear

stats
object

Execution stats from the Databricks job (columns detected, rows sampled, etc.); not persisted

Response

Successful response

data
object
required
success
enum<boolean>
required
Available options:
true