Get a package's schema and column values

GET

/v1/yac/metadata

curl --request GET \
  --url 'https://example.com/v1/yac/metadata?refresh=false' \
  --header 'Authorization: Bearer <token>'

Backend-introspected dataSchema/dataDomains for a package — the remote-mode replacement for browser-side CSV domain computation. Cached with a TTL; pass ?refresh=1 to force re-introspection.

Authorizations

• HTTPBearer

Parameters

Query Parameters

package

Any of:

string

string

null

null

refresh

Refresh

boolean

Responses

200

Successful Response

Media typeapplication/json

MetadataResponse

object

package

required

Package

string

interactive

Interactive

Always false: the package is queried on the server, not in the browser.

boolean

dataSchema

required

Dataschema

The data package descriptor, introspected from the database.

object

key

additional properties

any

dataDomains

required

Datadomains

Each column’s values or range.

Array<object>

object

key

additional properties

any

Example

{
  "interactive": false
}

401

Missing, invalid or expired token (detail).

Media typeapplication/json

ErrorResponse

An error body. Authentication failures carry FastAPI’s detail instead of error.

object

error

Any of:

string

string

null

null

code

Any of:

string

string

null

null

errors

Any of:

Array<string>

Array<string>

null

null

detail

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

null

null

Example ^generated

{
  "error": "example",
  "code": "example",
  "errors": [
    "example"
  ],
  "detail": [
    {}
  ]
}

403

database_forbidden: the database rejected the caller’s forwarded identity (JWT passthrough).

Media typeapplication/json

ErrorResponse

An error body. Authentication failures carry FastAPI’s detail instead of error.

object

error

Any of:

string

string

null

null

code

Any of:

string

string

null

null

errors

Any of:

Array<string>

Array<string>

null

null

detail

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

null

null

Example ^generated

{
  "error": "example",
  "code": "example",
  "errors": [
    "example"
  ],
  "detail": [
    {}
  ]
}

404

no_backend: no query backend is configured for the package.

Media typeapplication/json

ErrorResponse

An error body. Authentication failures carry FastAPI’s detail instead of error.

object

error

Any of:

string

string

null

null

code

Any of:

string

string

null

null

errors

Any of:

Array<string>

Array<string>

null

null

detail

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

null

null

Example ^generated

{
  "error": "example",
  "code": "example",
  "errors": [
    "example"
  ],
  "detail": [
    {}
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

503

The identity provider’s keys could not be fetched (JWT_JWKS_URL).

Media typeapplication/json

ErrorResponse

An error body. Authentication failures carry FastAPI’s detail instead of error.

object

error

Any of:

string

string

null

null

code

Any of:

string

string

null

null

errors

Any of:

Array<string>

Array<string>

null

null

detail

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

null

null

Example ^generated

{
  "error": "example",
  "code": "example",
  "errors": [
    "example"
  ],
  "detail": [
    {}
  ]
}