Get request schemas for v1 operations
curl --request GET \
--url https://useorgx.com/api/v1/meta/schemasconst options = {method: 'GET'};
fetch('https://useorgx.com/api/v1/meta/schemas', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://useorgx.com/api/v1/meta/schemas"
response = requests.get(url)
print(response.text){
"data": {
"version": "1",
"dialect": "https://json-schema.org/draft/2020-12/schema",
"generated_from": "The validators the route handlers parse with, converted at module load.",
"enums_url": "https://useorgx.com/api/v1/meta/enums",
"errors_url": "https://useorgx.com/api/v1/errors",
"request_schemas": [
{
"id": "returnHandoff",
"method": "POST",
"path": "/handoffs/{handoffId}/return",
"location": "body",
"description": "Return a claimed handoff to its origin stage. Concurrency is checked against expected_aggregate_version.",
"json_schema": {
"type": "object",
"required": [
"workspace_id",
"expected_aggregate_version"
],
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"expected_aggregate_version": {
"type": "integer",
"minimum": 0
}
}
}
}
],
"document_schemas": [
{
"id": "agentWorkReceipt",
"description": "The Agent Work Receipt document accepted by the importer and the account-free validator.",
"json_schema": {
"$ref": "#/components/schemas/AgentWorkReceipt"
}
}
]
},
"meta": {
"apiVersion": "1",
"count": 9
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"issues": [
{}
]
},
"ok": true,
"valid": true
}API discovery
Get request schemas for v1 operations
JSON Schema for the request bodies the API enforces, generated from the same validators the handlers parse with, so the published shape matches the enforced shape.
Covers the operations whose inner shapes are otherwise reachable only by trial and error: decisions, operating-process proposals, the handoff return, escalate, and cancel bodies, lifecycle commands, discovery promotion, and receipt import. Account-free.
GET
/
meta
/
schemas
Get request schemas for v1 operations
curl --request GET \
--url https://useorgx.com/api/v1/meta/schemasconst options = {method: 'GET'};
fetch('https://useorgx.com/api/v1/meta/schemas', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://useorgx.com/api/v1/meta/schemas"
response = requests.get(url)
print(response.text){
"data": {
"version": "1",
"dialect": "https://json-schema.org/draft/2020-12/schema",
"generated_from": "The validators the route handlers parse with, converted at module load.",
"enums_url": "https://useorgx.com/api/v1/meta/enums",
"errors_url": "https://useorgx.com/api/v1/errors",
"request_schemas": [
{
"id": "returnHandoff",
"method": "POST",
"path": "/handoffs/{handoffId}/return",
"location": "body",
"description": "Return a claimed handoff to its origin stage. Concurrency is checked against expected_aggregate_version.",
"json_schema": {
"type": "object",
"required": [
"workspace_id",
"expected_aggregate_version"
],
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"expected_aggregate_version": {
"type": "integer",
"minimum": 0
}
}
}
}
],
"document_schemas": [
{
"id": "agentWorkReceipt",
"description": "The Agent Work Receipt document accepted by the importer and the account-free validator.",
"json_schema": {
"$ref": "#/components/schemas/AgentWorkReceipt"
}
}
]
},
"meta": {
"apiVersion": "1",
"count": 9
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"issues": [
{}
]
},
"ok": true,
"valid": true
}