When to Use Saved Schemas
Use saved schemas when you:- Extract the same data structure from multiple websites
- Want to maintain consistent field definitions across workflows
- Need to programmatically manage schema lifecycle
- Share schemas across different parts of your application
Create a Schema
Get a Schema
Retrieve an existing schema by ID:Delete a Schema
Remove a schema when it’s no longer needed:Deleting a schema does not affect existing workflows or extractions that were created using it.
Use a Saved Schema
Reference a saved schema in your extraction:Field Types
Schemas support three types of fields:- Regular fields - Structured data extraction (shown above)
- Classification fields - Categorize content into predefined labels
- Metadata fields - Extract raw page content (HTML, Markdown, URLs)
Available Data Types
For regular fields, specify thedataType
:
STRING
• NUMBER
• BOOLEAN
• DATE
• DATETIME
• MONEY
• IMAGE
• LINK
• OBJECT
• ARRAY
See data type details and examples →
Classification Fields
Categorize extracted content into predefined labels:Metadata Fields (Raw Content)
Extract raw page content alongside structured data:HTML
• MARKDOWN
• PAGE_URL
Best Practices
- Use descriptive names - Make schema names clear and specific (e.g., “E-commerce Product Schema” vs “Schema 1”)
- Provide examples - Include example values for STRING fields to improve extraction accuracy
- Keep schemas focused - Create separate schemas for different entity types rather than combining them
- Version your schemas - Include version numbers in schema names when making significant changes (e.g., “Product Schema v2”)
- Document field purposes - Write clear descriptions for each field to help future developers understand the schema
Troubleshooting
Duplicate Schema Names
Each schema name must be unique within your workspace. If you get a duplicate name error:Schema Not Found
Ensure the schema ID is correct and the schema hasn’t been deleted:Related Resources
- SDK Introduction - Learn about inline schema definitions
- Data Types Reference - Complete data type documentation
- API Reference - Full API documentation