Retained glossary API

API and SDK index

These qualified retained operations are separate from the canonical count. SDK mappings, schemas and headers come from the manifest. Parameter signatures and success statuses are read from the matching native controller source; generation rejects a controller or admission guard whose digest differs from the manifest. HTTP mappings without an explicit status use the native framework default of 200. The structured module and its native datasource must be configured.

Pass the canonical tenant and workspace through X-Tenant-ID and X-Workspace-ID. For updates and deletion, preserve the exact returned updated_at string, including microseconds and its offset, for the If-Match precondition. List totals can be unknown; honor the returned limit, offset and has_more.

GlossaryController.list_terms

HTTP

GET /api/v1/structured/glossary

SDK	Method
Python	glossary_terms
TypeScript	structured.glossary.list
Java	client.structuredGlossary(tenant,workspace).list

Contract	Value
Request schema	No request schema declared
Response schema	GlossaryPage
Success status	200
Encoding	application/json

Headers

• X-Tenant-ID
• X-Workspace-ID

Parameters

Name	Location	Declared type	Required	Default
X-Tenant-ID	header	str	Yes	Not specified
X-Workspace-ID	header	str	Yes	Not specified
limit	query	QueryParam[int]	No	100
offset	query	QueryParam[int]	No	0

GlossaryController.get_term

HTTP

GET /api/v1/structured/glossary/{term_id}

SDK	Method
Python	glossary_term
TypeScript	structured.glossary.get
Java	client.structuredGlossary(tenant,workspace).get

Contract	Value
Request schema	No request schema declared
Response schema	GlossaryTermRead
Success status	200
Encoding	application/json

Headers

• X-Tenant-ID
• X-Workspace-ID

Parameters

Name	Location	Declared type	Required	Default
X-Tenant-ID	header	str	Yes	Not specified
X-Workspace-ID	header	str	Yes	Not specified
term_id	path	PathVar[uuid.UUID]	Yes	Not specified

GlossaryController.create

HTTP

POST /api/v1/structured/glossary

SDK	Method
Python	create_glossary_term
TypeScript	structured.glossary.create
Java	client.structuredGlossary(tenant,workspace).create

Contract	Value
Request schema	GlossaryTermCreate
Response schema	GlossaryTermRead
Success status	201
Encoding	application/json

Headers

• X-Tenant-ID
• X-Workspace-ID

Parameters

Name	Location	Declared type	Required	Default
X-Tenant-ID	header	str	Yes	Not specified
X-Workspace-ID	header	str	Yes	Not specified
body	body	Valid[Body[GlossaryTermCreate]]	Yes	Not specified

GlossaryController.update

HTTP

PUT /api/v1/structured/glossary/{term_id}

SDK	Method
Python	update_glossary_term
TypeScript	structured.glossary.update
Java	client.structuredGlossary(tenant,workspace).update

Contract	Value
Request schema	GlossaryTermUpdate
Response schema	GlossaryTermRead
Success status	200
Encoding	application/json

Headers

• X-Tenant-ID
• X-Workspace-ID
• If-Match (exact unparsed updated_at string)

Parameters

Name	Location	Declared type	Required	Default
X-Tenant-ID	header	str	Yes	Not specified
X-Workspace-ID	header	str	Yes	Not specified
term_id	path	PathVar[uuid.UUID]	Yes	Not specified
body	body	Valid[Body[GlossaryTermUpdate]]	Yes	Not specified
If-Match	header	str	Yes	Not specified

GlossaryController.delete

HTTP

DELETE /api/v1/structured/glossary/{term_id}

SDK	Method
Python	delete_glossary_term
TypeScript	structured.glossary.remove
Java	client.structuredGlossary(tenant,workspace).remove

Contract	Value
Request schema	No request schema declared
Response schema	No response body
Success status	204
Encoding	application/json

Headers

• X-Tenant-ID
• X-Workspace-ID
• If-Match (exact unparsed updated_at string)

Parameters

Name	Location	Declared type	Required	Default
X-Tenant-ID	header	str	Yes	Not specified
X-Workspace-ID	header	str	Yes	Not specified
term_id	path	PathVar[uuid.UUID]	Yes	Not specified
If-Match	header	str	Yes	Not specified

AgentGlossaryController.list_terms

HTTP

GET /api/v1/structured/agent/glossary

SDK	Method
Python	glossary_terms(agent=True)
TypeScript	structured.agentGlossary.list
Java	client.structuredAgentGlossary(tenant,workspace).list

Contract	Value
Request schema	No request schema declared
Response schema	GlossaryPage
Success status	200
Encoding	application/json

Headers

• X-Tenant-ID
• X-Workspace-ID

Parameters

Name	Location	Declared type	Required	Default
X-Tenant-ID	header	str	Yes	Not specified
X-Workspace-ID	header	str	Yes	Not specified
limit	query	QueryParam[int]	No	100
offset	query	QueryParam[int]	No	0

AgentGlossaryController.get_term

HTTP

GET /api/v1/structured/agent/glossary/{term_id}

SDK	Method
Python	glossary_term(agent=True)
TypeScript	structured.agentGlossary.get
Java	client.structuredAgentGlossary(tenant,workspace).get

Contract	Value
Request schema	No request schema declared
Response schema	GlossaryTermRead
Success status	200
Encoding	application/json

Headers

• X-Tenant-ID
• X-Workspace-ID

Parameters

Name	Location	Declared type	Required	Default
X-Tenant-ID	header	str	Yes	Not specified
X-Workspace-ID	header	str	Yes	Not specified
term_id	path	PathVar[uuid.UUID]	Yes	Not specified

AgentGlossaryController.create

HTTP

POST /api/v1/structured/agent/glossary

SDK	Method
Python	create_glossary_term(agent=True)
TypeScript	structured.agentGlossary.create
Java	client.structuredAgentGlossary(tenant,workspace).create

Contract	Value
Request schema	GlossaryTermCreate
Response schema	GlossaryTermRead
Success status	201
Encoding	application/json

Headers

• X-Tenant-ID
• X-Workspace-ID

Parameters

Name	Location	Declared type	Required	Default
X-Tenant-ID	header	str	Yes	Not specified
X-Workspace-ID	header	str	Yes	Not specified
body	body	Valid[Body[GlossaryTermCreate]]	Yes	Not specified

AgentGlossaryController.update

HTTP

PUT /api/v1/structured/agent/glossary/{term_id}

SDK	Method
Python	update_glossary_term(agent=True)
TypeScript	structured.agentGlossary.update
Java	client.structuredAgentGlossary(tenant,workspace).update

Contract	Value
Request schema	GlossaryTermUpdate
Response schema	GlossaryTermRead
Success status	200
Encoding	application/json

Headers

• X-Tenant-ID
• X-Workspace-ID
• If-Match (exact unparsed updated_at string)

Parameters

Name	Location	Declared type	Required	Default
X-Tenant-ID	header	str	Yes	Not specified
X-Workspace-ID	header	str	Yes	Not specified
term_id	path	PathVar[uuid.UUID]	Yes	Not specified
body	body	Valid[Body[GlossaryTermUpdate]]	Yes	Not specified
If-Match	header	str	Yes	Not specified

AgentGlossaryController.delete

HTTP

DELETE /api/v1/structured/agent/glossary/{term_id}

SDK	Method
Python	delete_glossary_term(agent=True)
TypeScript	structured.agentGlossary.remove
Java	client.structuredAgentGlossary(tenant,workspace).remove

Contract	Value
Request schema	No request schema declared
Response schema	No response body
Success status	204
Encoding	application/json

Headers

• X-Tenant-ID
• X-Workspace-ID
• If-Match (exact unparsed updated_at string)

Parameters

Name	Location	Declared type	Required	Default
X-Tenant-ID	header	str	Yes	Not specified
X-Workspace-ID	header	str	Yes	Not specified
term_id	path	PathVar[uuid.UUID]	Yes	Not specified
If-Match	header	str	Yes	Not specified