When creating records using AI prompts, follow these guidelines for best results.
Best Practices
Be Specific
Include all relevant details in your prompts:
- Dates (e.g., “dated January 15, 2024” or “dated today”)
- Amounts (e.g., “$1,000” or “500.00”)
- Contacts (e.g., “for customer ABC Company”)
- Descriptions (e.g., “for web development services”)
Use Natural Language
Describe what you want in plain English. The AI understands natural language descriptions.
Include Context
Mention related information to help the AI understand the full context of the record.
Specify Dates
Always include dates in your prompts. Use formats like:
- “dated today”
- “dated January 15, 2024”
- “due in 30 days”
Good Examples
Bad Examples
Avoid vague prompts that lack essential information.
Tips
- Amounts in prompts: Natural language can include
$ or plain numbers; in structured JSON bodies (e.g. payments), send numeric amounts without currency symbols unless an endpoint documents otherwise.
- Dates: Be explicit in prompts; structured bodies use
YYYY-MM-DD where required.
- Contacts: Include names, emails, or phone numbers when relevant.
- Bank upload:
POST /bank-transactions/upload requires prompt — describe or paste lines clearly. Optional attachments carry statement files.
process_type: Use async for background processing (default on most AI creates) or direct when you need the result in the same HTTP response — see Concepts.
