Schemas
Schema management endpoints
Schema management endpoints
List schemas
List schemas with cursor pagination.
Query Parameters
project?string
Project override
limit?integer
Page size (max 500)
cursor?string
Opaque pagination cursor
q?string
Filter by schema ID prefix
Response Body
curl -X GET "https://loading/api/v0/schemas?project=string&limit=0&cursor=string&q=string"{
"data": {
"page": {
"limit": 50,
"next_cursor": "v2:after:tool-001",
"prev_cursor": "v2:before:tool-000",
"total": 2
},
"schemas": [
{
"body": [
0
],
"etag": "abc123"
}
]
},
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}{
"code": "invalid_cursor",
"detail": "Invalid cursor parameter",
"instance": "/api/v0/workflows",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}{
"code": "invalid_cursor",
"detail": "Invalid cursor parameter",
"instance": "/api/v0/workflows",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}Get schema
Retrieve a schema by ID.
Path Parameters
schema_idstring
Schema ID
Query Parameters
project?string
Project override
Response Body
curl -X GET "https://loading/api/v0/schemas/string?project=string"{
"data": {
"body": [
0
]
},
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}{
"code": "invalid_cursor",
"detail": "Invalid cursor parameter",
"instance": "/api/v0/workflows",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}{
"code": "invalid_cursor",
"detail": "Invalid cursor parameter",
"instance": "/api/v0/workflows",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}{
"code": "invalid_cursor",
"detail": "Invalid cursor parameter",
"instance": "/api/v0/workflows",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}Create or update schema
Create a schema when absent or update an existing schema using strong ETag concurrency.
Path Parameters
schema_idstring
Schema ID
Query Parameters
project?string
Project override
Header Parameters
If-Match?string
Strong ETag for optimistic concurrency
Schema definition payload
Empty Object
Response Body
curl -X PUT "https://loading/api/v0/schemas/string?project=string" \
-H "If-Match: string" \
-H "Content-Type: application/json" \
-d '{}'{
"data": {
"body": [
0
]
},
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}{
"data": {
"body": [
0
]
},
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}{
"code": "invalid_cursor",
"detail": "Invalid cursor parameter",
"instance": "/api/v0/workflows",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}{
"code": "invalid_cursor",
"detail": "Invalid cursor parameter",
"instance": "/api/v0/workflows",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}{
"code": "invalid_cursor",
"detail": "Invalid cursor parameter",
"instance": "/api/v0/workflows",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}{
"code": "invalid_cursor",
"detail": "Invalid cursor parameter",
"instance": "/api/v0/workflows",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}{
"code": "invalid_cursor",
"detail": "Invalid cursor parameter",
"instance": "/api/v0/workflows",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}Delete schema
Delete a schema configuration. Returns conflict when referenced.
Path Parameters
schema_idstring
Schema ID
Query Parameters
project?string
Project override
Response Body
curl -X DELETE "https://loading/api/v0/schemas/string?project=string""string"{
"code": "invalid_cursor",
"detail": "Invalid cursor parameter",
"instance": "/api/v0/workflows",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}{
"code": "invalid_cursor",
"detail": "Invalid cursor parameter",
"instance": "/api/v0/workflows",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}{
"code": "invalid_cursor",
"detail": "Invalid cursor parameter",
"instance": "/api/v0/workflows",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}