Skip to main content
POST
TypeScript SDK

Work out an Artifact's schema

work_out_artifact_schema

Authorizations

Authorization
string
header
required

A personal access token, which starts with pat_. A Parable token can call each operation that the roles of its owner allow. An MCP token can call only the read operations that are open to agents. A SQL token does not work on this API.

Headers

X-Tenant
string

Workspace slug. Overrides subdomain-based workspace resolution when provided.

Example:

"acme"

X-Request-ID
string<uuid>

Optional request correlation ID echoed back in the response.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

Input for running (or re-running) schema inference on an existing artifact.

artifactId
string
required

UUID v4 with automatic base62 encoding for client-facing APIs

Pattern: ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Response

Successful response

data
object
required

Shared result shape for uploadArtifact and runArtifactSchemaInference. Carries the persisted artifact record alongside optional inference output and a small sample-row preview so the schema editor can render without an extra round trip. Inference fields are populated only by runArtifactSchemaInference. In uploadArtifact responses, inference, inferenceError and inferenceRefusal are always null (upload never runs inference).

meta
object
required