---
title: "Read Metadata"
method: GET
path: "/knowledge/definitions/{kind}/{definition_id}/metadata"
tags: ["knowledge"]
---

# Read Metadata

`GET /knowledge/definitions/{kind}/{definition_id}/metadata`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/knowledge/definitions/{kind}/{definition_id}/metadata`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Path parameters

- `kind` 'entity_type' | 'property_type' | 'checkpoint', required
- `definition_id` string, required

## Headers

- `timezone` string
- `x-user-id` string, nullable
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable
- `organization-id` string, nullable

## Response `200`

Successful Response

- DefinitionMetadataResponse
  - `kind` 'entity_type' | 'property_type' | 'checkpoint', required
  - `definition_id` string, required
  - `organization_id` string, nullable, required
  - `revision` string, required
  - `documentation` DefinitionDocumentation, required
    - `schema_version` 1
    - `label` string, nullable
    - `description` string, nullable
    - `guidance` string, nullable
  - `ui_config` DefinitionUIConfig, required
    - `schema_version` 1
    - `section` string, nullable
    - `order` integer, nullable
    - `hidden` boolean

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/86e2c2bd93af?raw)