Schema client
July 29, 2026 · View on GitHub
SchemaClient (OrkesClients.getSchemaClient()) manages versioned schema
definitions through the Conductor schema API — registerSchema, getSchema,
getAllSchemas, deleteSchema.
const schemas = clients.getSchemaClient();
await schemas.registerSchema([{ name: "order", type: "JSON", version: 1, data: {} }]);
OSS/Orkes: availability depends on the server deployment and permissions. Validate schemas in a non-production environment before making them required by workers or tasks.
There is no dedicated schema-client.md API reference page yet (tracked in
documentation-parity.md);
see the schemas API journey example
for a runnable walkthrough of every method in the meantime.