Delete Chunk V3chunks ID Delete Request Unprocessable Entity Error

List Chunks V3chunks Get Request Unprocessable Entity Error

Retrieve Chunk V3chunks ID Get Request Unprocessable Entity Error

Search Chunks V3chunks Search Post Request Unprocessable Entity Error

Update Chunk V3chunks ID Post Request Unprocessable Entity Error

Add Document to Collection V3collections ID Documents Document ID Post Request Unprocessable Entity Error

Add User to Collection V3collections ID Users User ID Post Request Unprocessable Entity Error

Create Collection V3collections Post Request Unprocessable Entity Error

name

string

Delete Collection V3collections ID Delete Request Unprocessable Entity Error

Export Collections V3collections Export Post Request Unprocessable Entity Error

Extract V3collections ID Extract Post Request Unprocessable Entity Error

Get Collection V3collections ID Get Request Unprocessable Entity Error

Get Collection Documents V3collections ID Documents Get Request Unprocessable Entity Error

Get Collection Users V3collections ID Users Get Request Unprocessable Entity Error

List Collections V3collections Get Request Unprocessable Entity Error

Remove Document from Collection V3collections ID Documents Document ID Delete Request Unprocessable Entity Error

Remove User from Collection V3collections ID Users User ID Delete Request Unprocessable Entity Error

Update Collection V3collections ID Post Request Unprocessable Entity Error

Build Communities V3graphs Collection ID Communities Build Post Request Unprocessable Entity Error

Create Community V3graphs Collection ID Communities Post Request Unprocessable Entity Error

Delete Community V3graphs Collection ID Communities Community ID Delete Request Unprocessable Entity Error

Export Relationships V3graphs Collection ID Communities Export Post Request Unprocessable Entity Error

Get Communities V3graphs Collection ID Communities Get Request Unprocessable Entity Error

Get Community V3graphs Collection ID Communities Community ID Get Request Unprocessable Entity Error

Update Community V3graphs Collection ID Communities Community ID Post Request Unprocessable Entity Error

Add Message V3conversations ID Messages Post Request Unprocessable Entity Error

Create Conversation V3conversations Post Request Unprocessable Entity Error

Delete Conversation V3conversations ID Delete Request Unprocessable Entity Error

Export Conversations V3conversations Export Post Request Unprocessable Entity Error

Export Messages V3conversations Export Messages Post Request Unprocessable Entity Error

Get Conversation V3conversations ID Get Request Unprocessable Entity Error

List Conversations V3conversations Get Request Unprocessable Entity Error

Update Conversation V3conversations ID Post Request Unprocessable Entity Error

Update Message V3conversations ID Messages Message ID Post Request Unprocessable Entity Error

Create Document V3documents Post Request Unprocessable Entity Error

Deduplicate V3documents ID Deduplicate Post Request Unprocessable Entity Error

Delete Document by Filter V3documents by Filter Delete Request Unprocessable Entity Error

Delete Document by ID V3documents ID Delete Request Unprocessable Entity Error

Export Documents V3documents Export Post Request Unprocessable Entity Error

Export Entities V3documents ID Entities Export Post Request Unprocessable Entity Error

Export Files V3documents Download Zip Get Request Unprocessable Entity Error

Export Relationships V3documents ID Relationships Export Post Request Unprocessable Entity Error

Extract V3documents ID Extract Post Request Unprocessable Entity Error

Get Document V3documents ID Get Request Unprocessable Entity Error

Get Document Collections V3documents ID Collections Get Request Unprocessable Entity Error

Get Document File V3documents ID Download Get Request Unprocessable Entity Error

Get Documents V3documents Get Request Unprocessable Entity Error

List Chunks V3documents ID Chunks Get Request Unprocessable Entity Error

Search Documents V3documents Search Post Request Unprocessable Entity Error

Create Entity V3graphs Collection ID Entities Post Request Unprocessable Entity Error

Delete Entity V3graphs Collection ID Entities Entity ID Delete Request Unprocessable Entity Error

Export Entities V3graphs Collection ID Entities Export Post Request Unprocessable Entity Error

Get Entities V3graphs Collection ID Entities Get Request Unprocessable Entity Error

Get Entity V3graphs Collection ID Entities Entity ID Get Request Unprocessable Entity Error

Update Entity V3graphs Collection ID Entities Entity ID Post Request Unprocessable Entity Error

Get Graph V3graphs Collection ID Get Request Unprocessable Entity Error

List Graphs V3graphs Get Request Unprocessable Entity Error

Pull V3graphs Collection ID Pull Post Request Unprocessable Entity Error

Reset V3graphs Collection ID Reset Post Request Unprocessable Entity Error

Update Graph V3graphs Collection ID Post Request Unprocessable Entity Error

Create Index V3indices Post Request Unprocessable Entity Error

Delete Index V3indices Table Name Index Name Delete Request Unprocessable Entity Error

Get Index V3indices Table Name Index Name Get Request Unprocessable Entity Error

List Indices V3indices Get Request Unprocessable Entity Error

Create Prompt V3prompts Post Request Unprocessable Entity Error

Delete Prompt V3prompts Name Delete Request Unprocessable Entity Error

:name

Get Prompt V3prompts Name Post Request Unprocessable Entity Error

Update Prompt V3prompts Name Put Request Unprocessable Entity Error

Create Relationship V3graphs Collection ID Relationships Post Request Unprocessable Entity Error

subject

Delete Relationship V3graphs Collection ID Relationships Relationship ID Delete Request Unprocessable Entity Error

Export Relationships V3graphs Collection ID Relationships Export Post Request Unprocessable Entity Error

Get Relationship V3graphs Collection ID Relationships Relationship ID Get Request Unprocessable Entity Error

Get Relationships V3graphs Collection ID Relationships Get Request Unprocessable Entity Error

Update Relationship V3graphs Collection ID Relationships Relationship ID Post Request Unprocessable Entity Error

Agent App V3retrieval Agent Post Request Unprocessable Entity Error

Completion V3retrieval Completion Post Request Unprocessable Entity Error

Embedding V3retrieval Embedding Post Request Unprocessable Entity Error

Rag App V3retrieval Rag Post Request Unprocessable Entity Error

Reasoning Agent App V3retrieval Rawr Post Request Unprocessable Entity Error

Search App V3retrieval Search Post Request Unprocessable Entity Error

Add User to Collection V3users ID Collections Collection ID Post Request Unprocessable Entity Error

Change Password V3users Change Password Post Request Unprocessable Entity Error

Create User API Key V3users ID API Keys Post Request Unprocessable Entity Error

Delete User V3users ID Delete Request Unprocessable Entity Error

Delete User API Key V3users ID API Keys Key ID Delete Request Unprocessable Entity Error

Export Users V3users Export Post Request Unprocessable Entity Error

Get User V3users ID Get Request Unprocessable Entity Error

Get User Collections V3users ID Collections Get Request Unprocessable Entity Error

Get User Limits V3users ID Limits Get Request Forbidden Error

Get User Limits V3users ID Limits Get Request Not Found Error

Get User Limits V3users ID Limits Get Request Unprocessable Entity Error

Git Hub Callback V3users OAuth Git Hub Callback Get Request Unprocessable Entity Error

Google Callback V3users OAuth Google Callback Get Request Unprocessable Entity Error

List User API Keys V3users ID API Keys Get Request Unprocessable Entity Error

List Users V3users Get Request Unprocessable Entity Error

Login V3users Login Post Request Unprocessable Entity Error

Refresh Token V3users Refresh Token Post Request Unprocessable Entity Error

Register V3users Post Request Unprocessable Entity Error

Remove User from Collection V3users ID Collections Collection ID Delete Request Unprocessable Entity Error

Request Password Reset V3users Request Password Reset Post Request Unprocessable Entity Error

Reset Password V3users Reset Password Post Request Unprocessable Entity Error

Send Verification Email V3users Send Verification Email Post Request Unprocessable Entity Error

Update User V3users ID Post Request Unprocessable Entity Error

Verify Email V3users Verify Email Post Request Unprocessable Entity Error

chunks

collections

communities

conversations

documents

entities

graphs

indices

prompts

relationships

retrieval

system

users

AgentResponse

AggregateSearchResult

ApiKey

ApiKeyNoPriv

BaseModel

BodyLoginV3UsersLoginPost

ChunkResponse

ChunkSearchResult

ChunkSearchSettings

CollectionResponse

Community

CommunityId

ContextDocumentResult

ConversationResponse

DocumentResponse

DocumentType

Entity

EntityDescriptionEmbedding

EntityMetadata

GenerationConfig

GenerationConfigResponseFormat

GenericBooleanResponse

GenericMessageResponse

GraphCommunityResult

GraphEntityResult

GraphRelationshipResult

GraphResponse

GraphSearchResult

GraphSearchResultContent

GraphSearchResultType

GraphSearchSettings

HttpValidationError

HybridSearchSettings

IndexArgsHnsw

IndexArgsIvfFlat

IndexConfig

IndexConfigIndexArguments

IndexMeasure

IngestionMode

IngestionResponse

IngestionStatus

KgCreationSettings

KgExtractionStatus

ListVectorIndicesResponse

Message

MessageResponse

MessageRole

MessageType

PaginatedR2RResultListApiKeyNoPriv

PaginatedR2RResultListChunkResponse

PaginatedR2RResultListCollectionResponse

PaginatedR2RResultListCommunity

PaginatedR2RResultListConversationResponse

PaginatedR2RResultListDocumentResponse

PaginatedR2RResultListEntity

PaginatedR2RResultListGraphResponse

PaginatedR2RResultListPromptResponse

PaginatedR2RResultListRelationship

PaginatedR2RResultListUser

PaginatedR2RResultListVectorIndicesResponse

PromptResponse

R2RResultsAgentResponse

R2RResultsAggregateSearchResult

R2RResultsApiKey

R2RResultsChunkResponse

R2RResultsCollectionResponse

R2RResultsCommunity

R2RResultsConversationResponse

R2RResultsDocumentResponse

R2RResultsEntity

R2RResultsGenericBooleanResponse

R2RResultsGenericMessageResponse

R2RResultsGraphResponse

R2RResultsIngestionResponse

R2RResultsListChunkSearchResult

R2RResultsListMessageResponse

R2RResultsMessageResponse

R2RResultsPromptResponse

R2RResultsRelationship

R2RResultsServerStats

The most advanced AI retrieval system.  Agentic Retrieval-Augmented Generation (RAG) with a RESTful API.

1	from r2r import R2RClient
2
3	client = R2RClient()
4	# when using auth, do client.login(...)
5
6	response = client.graphs.get(
7	collection_id="d09dedb1-b2ab-48a5-b950-6e1f464d83e7"
8	)

1	{
2	"results": {
3	"id": "id",
4	"collection_id": "collection_id",
5	"name": "name",
6	"status": "status",
7	"created_at": "2024-01-15T09:30:00Z",
8	"updated_at": "2024-01-15T09:30:00Z",
9	"document_ids": [
10	"document_ids"
11	],
12	"description": "description"
13	}
14	}

Retrieve graph details

Path parameters

Headers

Response

Errors