# Ragie

Fully managed RAG-as-a-Service for developers

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 31
- **Triggers:** 0
- **Slug:** `RAGIE`
- **Version:** 20260307_00

## Tools

### Create Document

**Slug:** `RAGIE_CREATE_DOCUMENT`

Tool to upload and process a document file in Ragie. Use when you need to create a new document with support for various formats including text, images, and documents. The endpoint accepts multipart/form-data and returns a Document object with processing status and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | No | The document file to upload. Supported formats: Plain Text (.eml.html.json.md.msg.rst.rtf.txt.xml), Images (.png.webp.jpg.jpeg.tiff.bmp.heic), Documents (.csv.doc.docx.epub.odt.pdf.ppt.pptx.tsv.xlsx.xls). Note: PDFs exceeding 2000 pages are unsupported in hi_res mode. If not provided, use raw_content and raw_filename instead. |
| `mode` | string | No | Processing strategy for the document. For text documents: 'hi_res' (extracts images/tables) or 'fast' (extracts text only, default). For audio: true/false. For video: 'audio_only', 'video_only', or 'audio_video'. Can specify 'all' for maximum quality across all media types. |
| `name` | string | No | Custom document name. Defaults to the file's name if omitted. |
| `metadata` | object | No | Custom key-value pairs for document metadata. Keys must be strings. Values can be strings, numbers, booleans, or string arrays. Maximum 1000 total values allowed. |
| `partition` | string | No | Partition scope for the document. Must be lowercase alphanumeric with only '_' and '-' allowed. |
| `rawContent` | string | No | Inline file content to upload as text or bytes. |
| `external_id` | string | No | Custom identifier for the document (e.g., external system ID or source URL). |
| `rawFilename` | string | No | Filename for inline content (e.g., 'document.txt'). Required when using raw_content. |
| `rawMimetype` | string | No | MIME type for the inline content (e.g., 'text/plain', 'application/pdf'). Defaults to text/plain. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Document From URL

**Slug:** `RAGIE_CREATE_DOCUMENT_FROM_URL`

Tool to ingest a document from a publicly accessible URL. Use when you need to add documents to Ragie from external sources. The document undergoes processing steps (pending, partitioning, indexed, ready) before becoming available for retrieval.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | URL of the file to download. Must be publicly accessible and use HTTP or HTTPS scheme. |
| `mode` | string | No | Partition strategy (hi_res/fast for text, boolean for audio, audio_only/video_only/audio_video for video); defaults to fast |
| `name` | string | No | Optional document name; defaults if omitted |
| `metadata` | object | No | Document metadata with string/number/boolean/array values; max 1000 total values |
| `partition` | string | No | Optional partition identifier for scoping |
| `external_id` | string | No | Optional external system identifier |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Document Raw

**Slug:** `RAGIE_CREATE_DOCUMENT_RAW`

Tool to ingest a document as raw text or JSON. Use when creating a new document from text or JSON data. The document goes through processing steps and becomes available for retrieval once in the ready state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Document data in text or JSON format. |
| `name` | string | No | An optional name for the document. If not set, defaults to the current timestamp. |
| `metadata` | object | No | Document metadata with string keys and string/number/boolean/array values; maximum 1000 total values. |
| `partition` | string | No | Document scope identifier; must be lowercase alphanumeric with only '_' and '-' special characters. |
| `external_id` | string | No | An optional identifier for the document. A common value might be an id in an external system or the URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Instruction

**Slug:** `RAGIE_CREATE_INSTRUCTION`

Tool to create a new instruction that applies natural language directives to documents as they're ingested or updated. Use when you need to define structured data extraction or analysis rules for documents in Ragie.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique identifier for the instruction |
| `scope` | string ("document" | "chunk") | No | Scope of instruction: 'document' for full analysis, 'chunk' for granular search (default: 'chunk') |
| `active` | boolean | No | Whether instruction applies to new/updated documents (default: true) |
| `filter` | object | No | Optional metadata filter matching document metadata before applying instruction |
| `prompt` | string | Yes | Natural language instruction which will be applied to documents as they are created and updated |
| `partition` | string | No | Optional partition identifier to scope instruction to specific partition |
| `entity_schema` | object | Yes | JSON Schema defining the entity structure generated by the instruction |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create OAuth Redirect URL

**Slug:** `RAGIE_CREATE_OAUTH_REDIRECT_URL`

Tool to create an OAuth redirect URL for initializing embedded connector OAuth flows. Use when you need to set up OAuth authentication for connectors like Google Drive, Notion, or HubSpot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string | No | Processing strategy (hi_res/fast for text, true/false for audio, audio_only/video_only/audio_video for video). |
| `theme` | string | No | UI theme preference: 'light', 'dark', or 'system'; defaults to 'system'. |
| `config` | object | No | Optional connector-specific configuration. |
| `metadata` | object | No | Document metadata with string/number/boolean/array values; max 1000 total values. |
| `partition` | string | No | Optional partition identifier to scope the connection. |
| `page_limit` | integer | No | Maximum pages to sync; connection disables when limit reached. |
| `source_type` | string | No | Connector type (e.g., google_drive, notion, hubspot); defaults to 'google_drive'. |
| `redirect_uri` | string | Yes | The URI where users return after OAuth authentication. |
| `authenticator_id` | string | No | Optional authenticator ID for white-labeled credentials (UUID format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Partition

**Slug:** `RAGIE_CREATE_PARTITION_PARTITIONS_POST`

Tool to create a new partition for scoping documents and connections in Ragie. Use when you need to organize documents and set resource limits for different workspaces or tenants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Identifier for the partition. This is a required field that uniquely identifies the partition. |
| `description` | string | No | Overview text describing the partition's purpose or usage |
| `metadata_schema` | object | No | Optional subset of document metadata defined as JSON Schema. Allows defining custom metadata structure for documents in this partition. |
| `media_hosted_limit_max` | integer | No | Maximum limit, in MBs, for media hosted |
| `pages_hosted_limit_max` | integer | No | Maximum limit, in pages, for hosted documents |
| `media_streamed_limit_max` | integer | No | Maximum limit, in MBs, for media streamed |
| `audio_processed_limit_max` | integer | No | Maximum limit, in minutes, for audio processing |
| `pages_processed_limit_max` | integer | No | Maximum limit, in pages, for processed documents |
| `video_processed_limit_max` | integer | No | Maximum limit, in minutes, for video processing |
| `media_hosted_limit_monthly` | integer | No | Monthly limit, in MBs, for media hosted |
| `pages_hosted_limit_monthly` | integer | No | Monthly limit of hosted pages added in the current month |
| `media_streamed_limit_monthly` | integer | No | Monthly limit, in MBs, for media streamed |
| `audio_processed_limit_monthly` | integer | No | Monthly limit, in minutes, for audio processing |
| `pages_processed_limit_monthly` | integer | No | Monthly limit, in pages, for processed documents |
| `video_processed_limit_monthly` | integer | No | Monthly limit, in minutes, for video processing |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Document

**Slug:** `RAGIE_DELETE_DOCUMENT`

Tool to delete a document from Ragie. Use when you need to remove a document permanently from the system. Supports both synchronous and asynchronous deletion modes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `async` | boolean | No | If true, performs document deletion asynchronously. Default is false for synchronous deletion. |
| `partition` | string | No | An optional partition to scope the request to. |
| `document_id` | string | Yes | The unique identifier (UUID) of the document to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Instruction

**Slug:** `RAGIE_DELETE_INSTRUCTION`

Tool to delete an instruction and all associated entities. Use when you need to permanently remove an instruction (irreversible operation). Requires the instruction ID (UUID format).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `instruction_id` | string | Yes | The unique identifier (UUID) of the instruction to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Partition

**Slug:** `RAGIE_DELETE_PARTITION`

Tool to delete a partition and all associated data irreversibly. Use when you need to permanently remove a partition. Returns status 200 for synchronous deletion or 202 for asynchronous deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `partition_id` | string | Yes | The partition identifier to delete |
| `async_deletion` | boolean | No | When true, performs partition deletion asynchronously. Defaults to false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document

**Slug:** `RAGIE_GET_DOCUMENT`

Tool to retrieve a specific document by its unique identifier. Use when you need to get document details, metadata, processing status, or check for errors. Returns comprehensive document information including chunk count, page count, and any processing errors.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `partition` | string | No | Scopes the request to a specific partition. If omitted, accounts created after 1/9/2025 will have the request scoped to the default partition. |
| `document_id` | string | Yes | The unique identifier of the document in UUID format (e.g., 00000000-0000-0000-0000-000000000000). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document Chunk

**Slug:** `RAGIE_GET_DOCUMENT_CHUNK`

Tool to retrieve a specific document chunk by its document and chunk ID. Use when you need detailed information about a specific chunk within a document, including its content, metadata, position index, and optional modality data for audio/video chunks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `chunk_id` | string | Yes | The ID of the chunk (UUID format). |
| `partition` | string | No | Optional partition to scope the request; if omitted, defaults to the default partition for newer accounts. |
| `document_id` | string | Yes | The ID of the document (UUID format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document Chunk Content

**Slug:** `RAGIE_GET_DOCUMENT_CHUNK_CONTENT`

Tool to retrieve document chunk content in requested format with streaming support for media. Use when you need to get the actual content of a specific chunk from a document.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `chunk_id` | string | Yes | The unique identifier of the chunk (UUID format). |
| `download` | boolean | No | Whether to return the content as a file download or a raw stream. Default is false. |
| `partition` | string | No | Optional partition identifier to scope the request for multi-tenant isolation. |
| `media_type` | string ("text/plain" | "audio/mpeg" | "video/mp4" | "image/webp" | "image/heic" | "image/bmp" | "image/png" | "image/jpeg" | "image/tiff") | No | Desired output format as MIME type. If not specified, returns the content in its original format. |
| `document_id` | string | Yes | The unique identifier of the document (UUID format). |
| `range_header` | string | No | Standard HTTP range header for byte-range requests (partial content), e.g., 'bytes=0-1023'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document Chunks

**Slug:** `RAGIE_GET_DOCUMENT_CHUNKS`

Tool to retrieve document chunks with pagination support. Lists all document chunks sorted by index in ascending order (max 100 items per page). Documents created prior to 9/18/2024 that have not been updated since have chunks sorted by ID instead of index.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | An opaque cursor for pagination used to retrieve subsequent pages. |
| `end_index` | integer | No | The inclusive ending index of the chunk range to list. Omitting both start_index and end_index returns all chunks. |
| `page_size` | integer | No | The number of items per page (range: 1-100, default: 10). |
| `partition` | string | No | Header parameter scoping results to a specific partition. |
| `document_id` | string | Yes | The UUID of the document to retrieve chunks from. |
| `start_index` | integer | No | The inclusive starting index of the chunk range to list. Omitting both start_index and end_index returns all chunks. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document Content

**Slug:** `RAGIE_GET_DOCUMENT_CONTENT`

Tool to retrieve the content of a document by its ID. Use when you need to access the full content of a specific document. The media_type parameter can be used to request content in different formats.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `range` | string | No | HTTP range header for partial content requests. |
| `download` | boolean | No | Whether to return content as file download. Defaults to false. |
| `partition` | string | No | An optional partition to scope the request to. |
| `media_type` | string | No | Format to return content in. Accepts: text/plain, audio/mpeg, video/mp4, image/webp, image/heic, image/bmp, image/png, image/jpeg, image/tiff, or application/json. Default returns content with text descriptions of non-textual media. |
| `document_id` | string | Yes | The UUID of the document to retrieve content for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document Summary

**Slug:** `RAGIE_GET_DOCUMENT_SUMMARY`

Tool to retrieve an LLM-generated summary of a document by its ID. Use when you need to get a concise summary of a document's content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `partition` | string | No | Optional partition scope. If omitted, accounts created after 1/9/2025 default to the default partition; older accounts scope to all partitions. |
| `document_id` | string | Yes | The unique identifier of the document (UUID format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Partition

**Slug:** `RAGIE_GET_PARTITION`

Tool to retrieve a partition by ID with usage statistics and resource limits. Use when you need to get detailed information about a specific partition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `partition_id` | string | Yes | The identifier for the partition being retrieved |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Response

**Slug:** `RAGIE_GET_RESPONSE`

Tool to retrieve a response by its unique identifier. Use when you need to check the status or details of a previously created response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `response_id` | string | Yes | The unique identifier (UUID format) for the response to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Connections

**Slug:** `RAGIE_LIST_CONNECTIONS_CONNECTIONS_GET`

Tool to list all connections sorted by creation date descending with pagination support. Use when you need to retrieve connections, optionally filtered by metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Pagination token for navigating to next page. |
| `filter` | string | No | Metadata filter supporting operators ($eq, $ne, $gt, $gte, $lt, $lte, $in, $nin) with AND/OR logic. |
| `page_size` | integer | No | Number of items per page, range 1-100, defaults to 10. |
| `partition` | string | No | Partition identifier to scope the request. Defaults to default partition if omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Connection Source Types

**Slug:** `RAGIE_LIST_CONNECTION_SOURCE_TYPES`

Tool to list available connection source types like 'google_drive' and 'notion' along with their metadata. Use when you need to discover what connector types are available in Ragie.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Documents

**Slug:** `RAGIE_LIST_DOCUMENTS`

Tool to list all documents sorted by creation date (descending) with pagination support. Use when you need to browse or retrieve document metadata. Supports filtering and pagination up to 100 items per page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | An opaque cursor for pagination. Use the next_cursor from previous response to get next page. |
| `filter` | string | No | Filter expression for documents. Supports operators: $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin. Can combine with AND/OR logic. |
| `page_size` | integer | No | The number of items per page. Must be between 1 and 100. Default is 10. |
| `partition` | string | No | Scopes request to specific partition. If not provided, default behavior varies by account creation date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Entities By Document

**Slug:** `RAGIE_LIST_ENTITIES_BY_DOCUMENT`

Tool to retrieve all extracted entities from a specific document with pagination support. Use when you need to access structured data that has been extracted from a document by Ragie's entity extraction instructions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | An opaque cursor for pagination. Use the next_cursor from a previous response to fetch the next page of results. |
| `page_size` | integer | No | Number of items per page. Must be between 1 and 100. Defaults to 10 if not specified. |
| `partition` | string | No | An optional partition to scope the request to. If omitted, scoped to default partition. |
| `document_id` | string | Yes | The ID of the document from which to retrieve entities. Must be a valid UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Entities by Instruction

**Slug:** `RAGIE_LIST_ENTITIES_BY_INSTRUCTION`

Tool to retrieve entities generated by a specific instruction. Use when you need to fetch entities extracted from documents based on a specific instruction's processing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | An opaque cursor for pagination to fetch the next page of results. |
| `page_size` | integer | No | The number of items per page. Must be between 1 and 100. Default is 10. |
| `partition` | string | No | An optional partition to scope the request to. |
| `instruction_id` | string | Yes | The ID of the instruction (UUID format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Instructions

**Slug:** `RAGIE_LIST_INSTRUCTIONS`

Tool to retrieve all instruction records from the Ragie system. Use when you need to view all available instructions that define natural language prompts and entity schemas applied to documents.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Partitions

**Slug:** `RAGIE_LIST_PARTITIONS`

Tool to retrieve a paginated list of all partitions sorted by name in ascending order. Use when you need to list available partitions with their configurations and limits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | An opaque cursor for pagination to retrieve the next page of results |
| `page_size` | integer | No | The number of items per page (must be greater than 0 and less than or equal to 100). Defaults to 10. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch Document Metadata

**Slug:** `RAGIE_PATCH_DOCUMENT_METADATA`

Tool to update metadata for a specific document with partial update support. Use when you need to modify document metadata fields without replacing the entire metadata object. Supports both synchronous and asynchronous updates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `async` | boolean | No | Whether to run the metadata update asynchronously. If true, the metadata update will be run in the background and the response will be 202 Accepted. |
| `metadata` | object | Yes | The metadata to update on the document. Performs a partial update. Supports string, number, boolean, and string array values. Keys set to null are deleted. Maximum 1000 total values allowed. |
| `partition` | string | No | Optional partition scope. If omitted, accounts created after 1/9/2025 default to the default partition. |
| `document_id` | string | Yes | The unique identifier of the document (UUID format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Document Chunks

**Slug:** `RAGIE_RETRIEVE`

Tool to retrieve relevant document chunks based on a query. Use when you need to search and retrieve document content that matches a specific query, with optional filtering and reranking capabilities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | The query to search with when retrieving document chunks. |
| `top_k` | integer | No | The maximum number of chunks to return. Defaults to 8. |
| `filter` | object | No | Metadata search filter supporting operators: $eq (equal), $ne (not equal), $gt (greater than), $gte (greater than or equal), $lt (less than), $lte (less than or equal), $in (in array), $nin (not in array). Example: {"department": {"$in": ["sales", "marketing"]}}. |
| `rerank` | boolean | No | Reranks the chunks for semantic relevancy post cosine similarity. |
| `partition` | string | No | The partition to scope a retrieval to. If omitted, the retrieval will be scoped to the default partition. |
| `recency_bias` | boolean | No | Enables recency bias which will favor more recent documents vs older documents. |
| `max_chunks_per_document` | integer | No | Maximum number of chunks to retrieve per document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Partition Limits

**Slug:** `RAGIE_SET_PARTITION_LIMITS`

Tool to set usage limits on partition pages and media. Use when you need to configure monthly or maximum limits for pages processed/hosted, video/audio processing, or media streaming/hosting for a specific partition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `partition_id` | string | Yes | The identifier for the partition being modified. |
| `media_hosted_limit_max` | integer | No | Maximum media hosting limit in megabytes. |
| `pages_hosted_limit_max` | integer | No | Absolute maximum for hosted document pages. |
| `media_streamed_limit_max` | integer | No | Maximum media streaming limit in megabytes. |
| `audio_processed_limit_max` | integer | No | Maximum audio processing limit in minutes. |
| `pages_processed_limit_max` | integer | No | Absolute maximum for processed document pages. |
| `video_processed_limit_max` | integer | No | Maximum video processing limit in minutes. |
| `media_hosted_limit_monthly` | integer | No | Monthly media hosting limit in megabytes. |
| `pages_hosted_limit_monthly` | integer | No | Monthly cap for newly added hosted pages. |
| `media_streamed_limit_monthly` | integer | No | Monthly media streaming limit in megabytes. |
| `audio_processed_limit_monthly` | integer | No | Monthly audio processing limit in minutes. |
| `pages_processed_limit_monthly` | integer | No | Monthly cap for processed document pages. |
| `video_processed_limit_monthly` | integer | No | Monthly video processing limit in minutes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document From URL

**Slug:** `RAGIE_UPDATE_DOCUMENT_FROM_URL`

Tool to update an existing document by fetching content from a publicly accessible URL. Use when you need to refresh or replace a document's content with data from a web URL. The document goes through processing steps before it is ready for retrieval.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | URL of the file to download. Must be publicly accessible and use HTTP or HTTPS scheme. |
| `mode` | string | No | Processing strategy for different file types. Can be 'hi_res', 'fast', or a media configuration object. Defaults to 'fast'. |
| `partition` | string | No | Scopes the request to a specific partition |
| `document_id` | string | Yes | The unique identifier (UUID) of the document to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document Raw

**Slug:** `RAGIE_UPDATE_DOCUMENT_RAW`

Tool to update a document's content from raw text or JSON data. Use when modifying existing document content. The document undergoes processing and becomes available for retrieval once it reaches the ready state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | The document content in text or JSON format. Must be at least 1 character long. |
| `document_id` | string | Yes | UUID of the document to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Instruction

**Slug:** `RAGIE_UPDATE_INSTRUCTION`

Tool to update an instruction's active status. Use when you need to activate or deactivate an existing instruction.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `active` | boolean | Yes | Whether the instruction is active. Active instructions are applied to documents when they're created or when their file is updated |
| `instruction_id` | string | Yes | The UUID of the instruction to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Partition

**Slug:** `RAGIE_UPDATE_PARTITION`

Tool to update a partition's configuration including description, context-aware settings, and metadata schema. Use when you need to modify an existing partition's settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `description` | string | No | A text description explaining the purpose or contents of the partition. |
| `partition_id` | string | Yes | The unique identifier of the partition to update |
| `context_aware` | boolean | No | Enable context-aware descriptions for the partition. When enabled, the partition will generate contextual descriptions for content. |
| `metadata_schema` | object | No | A JSON Schema subset defining the metadata fields for documents in this partition. Providing detailed descriptions of fields helps LLMs generate filters dynamically. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |