Step 1: Sign Up & Generate Your API Token

Step 2: Make Your First API Request

Welcome to the Fieldwise API! This guide will help you get started with authentication and making your first API request.

Quickstart

Fieldwise.ai

Welcome to the Fieldwise API documentation. Our API offers a developer-friendly interface to enhance your document intelligence by providing real-time data retrieval and AI-driven insights.

Introduction

Upload a document and start processing it.

Ingest Document

Ingest Document From Url

 Answer a question based on the documents matching the provided metadata filter. <br /> The `metadata_filter` parameter supports MongoDB-like query syntax with operators: <br />
- Comparison: `$eq, $ne, $gt, $lt, $gte, $lte, $in, $nin`
- Array: `$contains, $containsAny, $notContains, $size`
- Logical: `$and, $or, $not`
- Type: `$type`
- Regex: `$regex, $iregex`
<br />
#### Example Metadata Filter
```json { "$and": [ { "category": "finance" }, { "tags": { "$contains": ["important"] } }, { "$or": [ { "priority": { "$gt": 2 } }, { "status": "active" } ] } ] } ```


Get Document Answer

List Documents

 Get the most relevant pages from documents matching the provided metadata filter. <br />
The `metadata_filter` parameter supports the same MongoDB-like query syntax as the [/answer](api-reference/documents/get-document-answer) endpoint. See [/answer](api-reference/documents/get-document-answer) endpoint documentation for detailed examples of metadata filtering.


Search document pages (deprecated)

Search through document pages using semantic similarity.

This endpoint performs a semantic search at the page level, which is best for:
- Finding broad context about a topic
- Getting an overview of document sections
- When you need more context around the matches

Performance Considerations:
- Fastest search performance of all levels
- Most efficient memory usage
- Best for initial broad searches
- Recommended for large document collections

Best Practices:
- Use for initial exploratory searches
- Combine with metadata filters for better performance
- Start with this before using more granular searches
- Ideal for queries needing broader context

The search uses embeddings to find the most semantically similar pages to your query,
regardless of exact keyword matches.

Search Document Pages

Search through document paragraphs using semantic similarity.

This endpoint performs a semantic search at the paragraph level, which is best for:
- Finding specific topics or concepts
- Getting more focused results than page-level search
- When you need a moderate amount of context

Performance Considerations:
- Moderate search performance
- Balanced memory usage
- Good for medium-sized document collections
- More vectors to search than pages

Best Practices:
- Use when page-level search is too broad
- Ideal for finding specific explanations
- Good for topic-focused research
- Consider using metadata filters to improve performance

Paragraphs provide a natural unit of text that maintains coherent thoughts and ideas,
making this search level ideal for finding self-contained explanations or descriptions.

Search Document Paragraphs

Search through document sentences using semantic similarity.

This endpoint performs a semantic search at the sentence level, which is best for:
- Finding very specific information or facts
- Getting precise answers to questions
- When you need the most granular search results

Performance Considerations:
- Slower search performance due to more vectors
- Highest memory usage
- Best for smaller, focused searches
- Consider impact on rate limits

Best Practices:
- Use only when specific facts are needed
- Keep document set focused using metadata filters
- Consider caching frequent queries
- Use smaller top_k values (5-10 recommended)

Sentence-level search provides the highest precision but with minimal context.
Each result is a single, focused statement or fact from the document.

Search Document Sentences

Retrieve the latest document by its external ID.

Get Document By External Id

Get Document By Id

Delete a single document by its internal ID.

Delete Document By Id

Retrieve a document by its task identifier.

Get Document By Task Id

Preview how many documents would be deleted by the metadata filter.

Preview Delete By Metadata

Delete all documents matching the provided metadata filter.

Delete Documents By Metadata

Retrieve a specific page by its ID, including all its paragraphs and sentences.
    The response is hierarchically structured with:
    - Page content and metadata
    - List of paragraphs (sorted by paragraph_index)
    - List of sentences within each paragraph (sorted by sentence_index)

Get page content with paragraphs and sentences

Retrieve a specific paragraph by its ID, including all its sentences.
    The response includes:
    - Paragraph content and metadata
    - List of sentences (sorted by sentence_index)

Get Started

​Step 1: Sign Up & Generate Your API Token

​Step 2: Make Your First API Request

Step 1: Sign Up & Generate Your API Token

Step 2: Make Your First API Request