Ragie integration (AI, Developer Tools). Imported from open-connector.
https://api.ragie.ai/retrievals
| Param | Type | Required | Description |
|---|---|---|---|
| query | string | required | The search query used for retrieval. |
| topK | integer | optional | The maximum number of chunks to return. |
| filter | object | optional | A loose JSON object accepted by Ragie. |
| rerank | boolean | optional | Whether Ragie should rerank chunks for semantic relevance. |
| partition | string | optional | The partition to scope retrieval to. |
| recencyBias | boolean | optional | Whether to favor newer documents during retrieval. |
| maxChunksPerDocument | integer | optional | The maximum number of chunks to return per document. |
/documents
| Param | Type | Required | Description |
|---|---|---|---|
| cursor | string | optional | The pagination cursor returned by a previous list call. |
| filter | string | optional | The filter expression used to narrow returned documents. |
| pageSize | integer | optional | The number of documents to return per page. |
| partition | string | optional | The partition to scope the request to. |
/documents/{documentId}
| Param | Type | Required | Description |
|---|---|---|---|
| documentId | string | required | The document identifier. |
| partition | string | optional | The partition to scope the request to. |
/documents/raw
| Param | Type | Required | Description |
|---|---|---|---|
| data | string | required | The raw data to ingest into Ragie. |
| name | string | optional | The user-facing document name. |
| metadata | object | optional | A metadata object containing Ragie-compatible primitive values. |
| partition | string | optional | The partition to place the document in. |
| externalId | string | optional | The external identifier of the document. |
/documents/url
| Param | Type | Required | Description |
|---|---|---|---|
| url | string | required | The public URL of the source document. |
| mode | string | optional | The optional processing mode for ingestion. |
| name | string | optional | The user-facing document name. |
| metadata | object | optional | A metadata object containing Ragie-compatible primitive values. |
| partition | string | optional | The partition to place the document in. |
| externalId | string | optional | The external identifier of the document. |
/documents/{documentId}/metadata
| Param | Type | Required | Description |
|---|---|---|---|
| documentId | string | required | The document identifier. |
| metadata | object | required | The metadata fields to upsert or remove with null values. |
| partition | string | optional | The partition to scope the request to. |
| async | boolean | optional | Whether Ragie should run the metadata patch asynchronously. |
/documents/{documentId}/content
| Param | Type | Required | Description |
|---|---|---|---|
| documentId | string | required | The document identifier. |
| range | string | optional | The HTTP byte range to request from Ragie. |
| download | boolean | optional | Whether Ragie should return content as a download. |
| partition | string | optional | The partition to scope the request to. |
| mediaType | string | optional | The media type to request from Ragie. |
/documents/{documentId}/summary
| Param | Type | Required | Description |
|---|---|---|---|
| documentId | string | required | The document identifier. |
| partition | string | optional | The partition to scope the request to. |
/documents/{documentId}/chunks
| Param | Type | Required | Description |
|---|---|---|---|
| documentId | string | required | The document identifier. |
| cursor | string | optional | The pagination cursor returned by a previous chunk list call. |
| pageSize | integer | optional | The number of chunks to return per page. |
| partition | string | optional | The partition to scope the request to. |
| startIndex | integer | optional | The inclusive starting chunk index. |
| endIndex | integer | optional | The inclusive ending chunk index. |
/documents/{documentId}
| Param | Type | Required | Description |
|---|---|---|---|
| documentId | string | required | The document identifier. |
| async | boolean | optional | Whether Ragie should delete the document asynchronously. |
| partition | string | optional | The partition to scope the request to. |
/partitions
| Param | Type | Required | Description |
|---|---|---|---|
| cursor | string | optional | The pagination cursor returned by a previous list call. |
| pageSize | integer | optional | The number of partitions to return per page. |
/partitions/{partitionId}
| Param | Type | Required | Description |
|---|---|---|---|
| partitionId | string | required | The partition identifier. |
/partitions
| Param | Type | Required | Description |
|---|---|---|---|
| name | string | required | The partition identifier to create. |
| description | string | optional | The partition description. |
| contextAware | boolean | optional | Whether the partition should generate context-aware descriptions. |
| metadataSchema | object | optional | A loose JSON object accepted by Ragie. |
| mediaHostedLimitMax | integer | optional | The maximum hosted media limit in megabytes. |
| pagesHostedLimitMax | integer | optional | The maximum hosted pages limit. |
| mediaStreamedLimitMax | integer | optional | The maximum streamed media limit in megabytes. |
| audioProcessedLimitMax | integer | optional | The maximum audio processing limit in minutes. |
| pagesProcessedLimitMax | integer | optional | The maximum processed pages limit. |
| videoProcessedLimitMax | integer | optional | The maximum video processing limit in minutes. |
| mediaHostedLimitMonthly | integer | optional | The monthly hosted media limit in megabytes. |
| pagesHostedLimitMonthly | integer | optional | The monthly hosted pages limit. |
| mediaStreamedLimitMonthly | integer | optional | The monthly streamed media limit in megabytes. |
| audioProcessedLimitMonthly | integer | optional | The monthly audio processing limit in minutes. |
| pagesProcessedLimitMonthly | integer | optional | The monthly processed pages limit. |
| videoProcessedLimitMonthly | integer | optional | The monthly video processing limit in minutes. |
/partitions/{partitionId}
| Param | Type | Required | Description |
|---|---|---|---|
| partitionId | string | required | The partition identifier. |
| description | string | optional | The updated partition description. |
| contextAware | boolean | optional | Whether the partition should be context-aware after the update. |
| metadataSchema | object | optional | A loose JSON object accepted by Ragie. |
/partitions/{partitionId}/limits
| Param | Type | Required | Description |
|---|---|---|---|
| partitionId | string | required | The partition identifier. |
| mediaHostedLimitMax | integer | optional | The maximum hosted media limit in megabytes. |
| pagesHostedLimitMax | integer | optional | The maximum hosted pages limit. |
| mediaStreamedLimitMax | integer | optional | The maximum streamed media limit in megabytes. |
| audioProcessedLimitMax | integer | optional | The maximum audio processing limit in minutes. |
| pagesProcessedLimitMax | integer | optional | The maximum processed pages limit. |
| videoProcessedLimitMax | integer | optional | The maximum video processing limit in minutes. |
| mediaHostedLimitMonthly | integer | optional | The monthly hosted media limit in megabytes. |
| pagesHostedLimitMonthly | integer | optional | The monthly hosted pages limit. |
| mediaStreamedLimitMonthly | integer | optional | The monthly streamed media limit in megabytes. |
| audioProcessedLimitMonthly | integer | optional | The monthly audio processing limit in minutes. |
| pagesProcessedLimitMonthly | integer | optional | The monthly processed pages limit. |
| videoProcessedLimitMonthly | integer | optional | The monthly video processing limit in minutes. |
/partitions/{partitionId}
| Param | Type | Required | Description |
|---|---|---|---|
| partitionId | string | required | The partition identifier. |
| asyncDeletion | boolean | optional | Whether Ragie should delete the partition asynchronously. |
/connections/source-type
/connections
| Param | Type | Required | Description |
|---|---|---|---|
| cursor | string | optional | The pagination cursor returned by a previous list call. |
| filter | string | optional | The filter expression used to narrow returned connections. |
| pageSize | integer | optional | The number of connections to return per page. |
| partition | string | optional | The partition to scope the request to. |
/connections/oauth
| Param | Type | Required | Description |
|---|---|---|---|
| redirectUri | string | required | The redirect URI that Ragie should return the user to. |
| sourceType | string | optional | The Ragie connection source type to authorize. |
| theme | string | optional | The theme for Ragie's OAuth UI. |
| config | object | optional | A loose JSON object accepted by Ragie. |
| metadata | object | optional | A metadata object containing Ragie-compatible primitive values. |
| partition | string | optional | The partition to scope the connection to. |
| pageLimit | integer | optional | The maximum number of pages Ragie may sync. |
| mode | string | optional | The optional processing mode for ingestion. |
| authenticatorId | string | optional | The white-label authenticator identifier to use. |