Skip to main content
Ragie logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 31
  • Triggers: 0
  • Slug: RAGIE
  • Version: 20261101_00

Tools

Slug: RAGIE_CREATE_DOCUMENTTool 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

object
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 inline file content with a filename instead.
string
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.
string
Custom document name. Defaults to the file’s name if omitted.
object
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.
string
Partition scope for the document. Must be lowercase alphanumeric with only ’_’ and ’-’ allowed.
string
Inline file content to upload as text or bytes.
string
Custom identifier for the document (e.g., external system ID or source URL).
string
Filename for inline content (e.g., ‘document.txt’). Required when using inline file content.
string
MIME type for the inline content (e.g., ‘text/plain’, ‘application/pdf’). Defaults to text/plain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_CREATE_DOCUMENT_FROM_URLTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_CREATE_DOCUMENT_RAWTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_CREATE_INSTRUCTIONTool 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

string
required
Unique identifier for the instruction
string ("document" | "chunk")
Scope of instruction: ‘document’ for full analysis, ‘chunk’ for granular search (default: ‘chunk’)
boolean
Whether instruction applies to new/updated documents (default: true)
object
Optional metadata filter matching document metadata before applying instruction
string
required
Natural language instruction which will be applied to documents as they are created and updated
string
Optional partition identifier to scope instruction to specific partition
object
required
JSON Schema defining the entity structure generated by the instruction

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_CREATE_OAUTH_REDIRECT_URLTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_CREATE_PARTITION_PARTITIONS_POSTTool 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

string
required
Identifier for the partition. This is a required field that uniquely identifies the partition.
string
Overview text describing the partition’s purpose or usage
object
Optional subset of document metadata defined as JSON Schema. Allows defining custom metadata structure for documents in this partition.
integer
Maximum limit, in MBs, for media hosted
integer
Maximum limit, in pages, for hosted documents
integer
Maximum limit, in MBs, for media streamed
integer
Maximum limit, in minutes, for audio processing
integer
Maximum limit, in pages, for processed documents
integer
Maximum limit, in minutes, for video processing
integer
Monthly limit, in MBs, for media hosted
integer
Monthly limit of hosted pages added in the current month
integer
Monthly limit, in MBs, for media streamed
integer
Monthly limit, in minutes, for audio processing
integer
Monthly limit, in pages, for processed documents
integer
Monthly limit, in minutes, for video processing

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_DELETE_DOCUMENTTool 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

boolean
If true, performs document deletion asynchronously. Default is false for synchronous deletion.
string
An optional partition to scope the request to.
string
required
The unique identifier (UUID) of the document to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_DELETE_INSTRUCTIONTool 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

string
required
The unique identifier (UUID) of the instruction to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_DELETE_PARTITIONDelete a partition and its associated data irreversibly, with optional asynchronous deletion.

Input Parameters

string
required
The partition identifier to delete
boolean
When true, performs partition deletion asynchronously. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_GET_DOCUMENTTool 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

string
Scopes the request to a specific partition. If omitted, accounts created after 1/9/2025 will have the request scoped to the default partition.
string
required
The unique identifier of the document in UUID format (e.g., 00000000-0000-0000-0000-000000000000).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_GET_DOCUMENT_CHUNKRetrieve a specific document chunk by document and chunk ID, including its text and position index. Chunk metadata and modality data are represented by empty objects in the response.

Input Parameters

string
required
The ID of the chunk (UUID format).
string
Optional partition to scope the request; if omitted, defaults to the default partition for newer accounts.
string
required
The ID of the document (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_GET_DOCUMENT_CHUNK_CONTENTRetrieve content for a specific document chunk, optionally requesting a media format or byte range. Text responses contain text; binary responses return a descriptive message rather than the media content.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_GET_DOCUMENT_CHUNKSTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_GET_DOCUMENT_CONTENTRetrieve a Ragie document’s content by ID, optionally scoped to a partition. You can request a media format, a byte range, or a download; non-JSON content is returned as text, including content requested in media formats.

Input Parameters

string
HTTP range header for partial content requests.
boolean
Whether to return content as file download. Defaults to false.
string
An optional partition to scope the request to.
string
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.
string
required
The UUID of the document to retrieve content for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_GET_DOCUMENT_SUMMARYTool 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

string
Optional partition scope. If omitted, accounts created after 1/9/2025 default to the default partition; older accounts scope to all partitions.
string
required
The unique identifier of the document (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_GET_PARTITIONTool 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

string
required
The identifier for the partition being retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_GET_RESPONSETool 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

string
required
The unique identifier (UUID format) for the response to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_LIST_CONNECTIONS_CONNECTIONS_GETTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_LIST_CONNECTION_SOURCE_TYPESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_LIST_DOCUMENTSTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_LIST_ENTITIES_BY_DOCUMENTTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_LIST_ENTITIES_BY_INSTRUCTIONTool 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

string
An opaque cursor for pagination to fetch the next page of results.
integer
The number of items per page. Must be between 1 and 100. Default is 10.
string
An optional partition to scope the request to.
string
required
The ID of the instruction (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_LIST_INSTRUCTIONSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_LIST_PARTITIONSTool 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

string
An opaque cursor for pagination to retrieve the next page of results
integer
The number of items per page (must be greater than 0 and less than or equal to 100). Defaults to 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_PATCH_DOCUMENT_METADATATool 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

boolean
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.
object
required
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.
string
Optional partition scope. If omitted, accounts created after 1/9/2025 default to the default partition.
string
required
The unique identifier of the document (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_RETRIEVETool 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

string
required
The query to search with when retrieving document chunks.
integer
The maximum number of chunks to return. Defaults to 8.
object
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”]}}.
boolean
Reranks the chunks for semantic relevancy post cosine similarity.
string
The partition to scope a retrieval to. If omitted, the retrieval will be scoped to the default partition.
boolean
Enables recency bias which will favor more recent documents vs older documents.
integer
Maximum number of chunks to retrieve per document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_SET_PARTITION_LIMITSTool 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

string
required
The identifier for the partition being modified.
integer
Maximum media hosting limit in megabytes.
integer
Absolute maximum for hosted document pages.
integer
Maximum media streaming limit in megabytes.
integer
Maximum audio processing limit in minutes.
integer
Absolute maximum for processed document pages.
integer
Maximum video processing limit in minutes.
integer
Monthly media hosting limit in megabytes.
integer
Monthly cap for newly added hosted pages.
integer
Monthly media streaming limit in megabytes.
integer
Monthly audio processing limit in minutes.
integer
Monthly cap for processed document pages.
integer
Monthly video processing limit in minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_UPDATE_DOCUMENT_FROM_URLTool 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

string
required
URL of the file to download. Must be publicly accessible and use HTTP or HTTPS scheme.
string
Processing strategy for different file types. Can be ‘hi_res’, ‘fast’, or a media configuration object. Defaults to ‘fast’.
string
Scopes the request to a specific partition
string
required
The unique identifier (UUID) of the document to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_UPDATE_DOCUMENT_RAWTool 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

string
required
The document content in text or JSON format. Must be at least 1 character long.
string
required
UUID of the document to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_UPDATE_INSTRUCTIONTool to update an instruction’s active status. Use when you need to activate or deactivate an existing instruction.

Input Parameters

boolean
required
Whether the instruction is active. Active instructions are applied to documents when they’re created or when their file is updated
string
required
The UUID of the instruction to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAGIE_UPDATE_PARTITIONTool 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

string
A text description explaining the purpose or contents of the partition.
string
required
The unique identifier of the partition to update
boolean
Enable context-aware descriptions for the partition. When enabled, the partition will generate contextual descriptions for content.
object
A JSON Schema subset defining the metadata fields for documents in this partition. Providing detailed descriptions of fields helps LLMs generate filters dynamically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not