Skip to main content
GET
/
schemas
/
{namespace}
/
{schema_type}
스키마 조회
curl --request GET \
  --url https://client-api.tryvox.co/v3/schemas/{namespace}/{schema_type} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "namespace": "<string>",
  "schema_type": "<string>",
  "version": "<string>",
  "name": "<string>",
  "is_active": true,
  "category": "<string>",
  "description": "<string>",
  "schema": {},
  "created_at": 123,
  "updated_at": 123
}

Authorizations

​
Authorization
string
header
required

조직 API 키를 Authorization: Bearer <token> 형식으로 보냅니다.

Path Parameters

​
namespace
string
required

스키마 namespace입니다. 주로 agent-schema, flow-schema, tool-schema를 사용합니다.

​
schema_type
string
required

namespace 안의 schema type입니다. 예: flow-data, agent-data-create, send_sms.

Query Parameters

​
version
string | null

스키마 버전입니다. 예: v1. 생략하면 최신 버전을 사용합니다.

​
detail
enum<string>
default:standard

응답 상세 수준입니다. standard는 전체 JSON Schema를 반환하고, minimal은 description/title/examples를 제거해 더 가볍게 반환합니다.

Available options:
minimal,
standard

Response

성공 응답

public schema registry 정의 1건입니다.

​
id
string
required

schema 정의 ID입니다. 같은 schema에 대해 응답 간 안정적으로 유지됩니다.

​
namespace
string
required

스키마 namespace입니다. 주로 agent-schema, flow-schema, tool-schema를 사용합니다.

​
schema_type
string
required

namespace 안의 schema type입니다. 예: agent-data-create, flow-data, send_sms.

​
version
string
required

스키마 버전입니다. v1처럼 v{n} 형식입니다.

​
name
string
required

사람이 읽을 수 있는 스키마 이름입니다.

​
source
enum<string>
required

schema source label입니다. 주로 진단용이며, 클라이언트는 namespace, schema_type, version을 기준으로 사용합니다.

Available options:
db,
code,
override
​
is_active
boolean
required

이 schema가 활성 상태인지 여부입니다. 코드 기반 schema는 항상 활성 상태입니다.

​
category
string | null

선택적 schema category입니다. 예: agent-authoring, built_in.

​
description
string | null

선택적 schema 설명입니다.

​
schema
Schema · object

JSON Schema 본문입니다. 상세 조회와 include_schema=true 목록 응답에 포함됩니다.

​
created_at
integer | null

리소스 생성 시각입니다. unix milliseconds 형식입니다.

​
updated_at
integer | null

리소스 마지막 수정 시각입니다. unix milliseconds 형식입니다.