The API Document Loader provides functionality to load and process data from external APIs using HTTP requests. This module enables seamless integration with RESTful APIs and web services.
This module provides a versatile API document loader that can:
* Make HTTP GET and POST requests
* Handle custom headers and request bodies
* Process API responses into documents
* Support JSON data structures
* Customize metadata extraction
* Process responses with text splitters
## Inputs
### Required Parameters
* **URL**: The API endpoint URL to call
* **Method**: HTTP method to use (GET or POST)
### Optional Parameters
* **Headers**: JSON object containing HTTP headers
* **Body**: JSON object for POST request body
* **Text Splitter**: A text splitter to process the extracted content
* **Additional Metadata**: JSON object with additional metadata
* **Omit Metadata Keys**: Comma-separated list of metadata keys to omit
## Outputs
* **Document**: Array of document objects containing metadata and pageContent
* **Text**: Concatenated string from pageContent of documents
## Features
* HTTP method support (GET/POST)
* Custom header configuration
* Request body customization
* Response processing
* Error handling
* Metadata customization
* Text splitting capabilities
## Example Usage
### GET Request
```json
{
"method": "GET",
"url": "https://api.example.com/data",
"headers": {
"Authorization": "Bearer token123",
"Accept": "application/json"
}
}
```
### POST Request
```json
{
"method": "POST",
"url": "https://api.example.com/data",
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer token123"
},
"body": {
"query": "example",
"limit": 10
}
}
```
## Notes
* Supports JSON request/response formats
* Handles HTTP error responses
* Automatically processes response data into documents
* Can be combined with text splitters for content processing
* Supports custom metadata addition and omission
* Error responses are properly handled and reported
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.flowiseai.com/integrations/langchain/document-loaders/api-loader.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.