Skip to main content

talonic_save_schema

Save a schema definition to the workspace for reuse. Returns a schema_id that can be passed to talonic_extract.

ParameterTypeDescription
name *stringHuman-readable schema name.
definition *objectSchema definition. Full JSON Schema `{type: "object", properties: {...}}` recommended.
descriptionstringWhat this schema extracts and when to use it.
Prefer full JSON Schema format with type: "object" and properties. The flat key-type map format is not fully supported server-side yet.

Example

Tool input
{
  "name": "Standard Invoice",
  "description": "Extracts vendor, line items, totals, and payment terms from invoices.",
  "definition": {
    "type": "object",
    "properties": {
      "vendor_name": { "type": "string" },
      "invoice_number": { "type": "string" },
      "total_amount": { "type": "number" },
      "due_date": { "type": "string", "format": "date" },
      "line_items": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "description": { "type": "string" },
            "amount": { "type": "number" }
          }
        }
      }
    },
    "required": ["vendor_name", "total_amount"]
  }
}
Tool response
{
  "id": "sch_7a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
  "short_id": "SCH-A1B2C3D4",
  "name": "Standard Invoice",
  "description": "Extracts vendor, line items, totals, and payment terms from invoices.",
  "version": 1,
  "field_count": 5
}