API Documentation
Examples
Examples
Schema examples
Examples of schemas and associated responses
Basic example
{
"name": "SimpleInvoice",
"description": "Basic invoice information",
"fields": [
{
"name": "invoice_number",
"description": "Unique invoice identifier",
"type": "string"
},
{
"name": "total_amount",
"description": "Total invoice amount",
"type": "number"
},
{
"name": "issue_date",
"description": "Invoice issue date",
"type": "date"
},
{
"name": "due_date",
"description": "Payment due date",
"type": "date"
}
]
}
With arrays and objects
{
"name": "DetailedInvoice",
"description": "Detailed invoice with line items and customer information",
"fields": [
{
"name": "invoice_number",
"description": "Unique invoice identifier",
"type": "string"
},
{
"name": "customer",
"description": "Customer details",
"type": "object",
"fields": [
{
"name": "name",
"description": "Customer name",
"type": "string"
},
{
"name": "email",
"description": "Customer email",
"type": "email"
},
{
"name": "phone",
"description": "Customer phone",
"type": "phone"
}
]
},
{
"name": "line_items",
"description": "Individual invoice items",
"type": "array",
"fields": [
{
"name": "description",
"description": "Item description",
"type": "string"
},
{
"name": "quantity",
"description": "Quantity of items",
"type": "number"
},
{
"name": "unit_price",
"description": "Price per unit",
"type": "number"
}
]
}
]
}
On this page
Assistant
Responses are generated using AI and may contain mistakes.