API Reference Guide

All API endpoints are authenticated using API keys.

1. Upload file

POST https://sso.raen.ai/collections/upload/{collection-name}

curl -X 'POST' \
  'https://sso.raen.ai/collections/upload/<your-collection_name>' \
  -H 'accept: application/json' \
  -H 'X-API-Key: <your-api-key>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@<uploaded_file_path>;type=<uploaded_file_mime_type>'

import requests

# Replace with actual values
collection_name = "<your-collection-name>"
file_path = "<your-file-path>"
file_mime_type = "<your-file-mime-type>"
api_key= "<your-api-key>"

url = f"https://sso.raen.ai/collections/upload/{collection_name}"

with open(file_path, "rb") as file:
    files = {"file": (file_path, file, file_mime_type)}  
    headers = {
        "accept": "application/json",
        "X-API-Key": api_key
    }

    response = requests.post(url, headers=headers, files=files)

print(f"Response Status: {response.status_code}")
print(f"Response Text: {response.text}")

Response

When the request is successful, you will receive an unique document ID in the response.

{
  "status": "File uploaded.",
  "collection_name": "<your-collection-name>",
  "document_id": <document-id>,
  "filename": "<your-file-name>",
  "metadata": {
    "user": "<user-name>",
    "type": "<file-type>",
    "size": <file-size>
  }
}

{
  "error": "Unsupported file type"
}

Key Notes:

Replace <your-collection-name> with the actual name of your collection.
Replace <your-api-key> with your actual API key.

2. Retrieve Documents

POST https://sso.raen.ai/collections/retrieve/{collection-name}

curl -X 'POST' \
  'https://sso.raen.ai/collections/retrieve/<collection-name>' \
  -H 'accept: application/json' \
  -H 'X-API-Key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "query": "<your-quesion>",
  "thread_id": "<pass unique string>",
  "top_k": 4
}'

import requests
import json

# Replace with actual values
collection_name = "<your-collection-name>"
api_key = "<your-api-key>"
query="<your-question>"
thread_id="<unique-string>"

url = f'https://sso.raen.ai/collections/retrieve/{collection_name}'
headers = {
    'accept': 'application/json',
    'X-API-Key': api_key,
    'Content-Type': 'application/json'
}
data = {
    'query': query,
    'thread_id': thread_id,# unique key that identifies this particular conversation
    'top_k': 4
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.json())

Response

[
  {
    "id": null,
    "metadata": {
      "source": "<file-location>",
      "filename": "<your-file-name>",
      "_id": "<unique-id>",
      "_collection_name": "<collection-name>",
      "document_id": <unique-document-id>
    },
    "page_content": "<your-page-content>",
    "type": "<document-type>"
  }
]

{
  "error": "Document cannot be retrieved."
}

Key Notes:

Replace <your-collection-name> with the actual name of your collection.
Replace <your-api-key> with your actual API key.
Replace <your-question> with your query.

3. Delete a file

DELETE https://sso.raen.ai/collections/files/{collection-name}

curl -X 'DELETE' \
  'https://sso.raen.ai/collections/files/<your-collection-name>' \
  -H 'accept: application/json' \
  -H 'X-API-Key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "doc_id": <your-document-id>,
  "delete_all": false
}'

import requests
import json

# Replace with actual values
collection_name="<your-collection-name>"
api_key = "<your-api-key>"
doc_id= <your-document-id>


url = f'https://sso.raen.ai/collections/files/{collection_name}'
headers = {
    'accept': 'application/json',
    'X-API-Key': api_key,
    'Content-Type': 'application/json'
}
data = {
    'doc_id': doc_id,
    'delete_all': False
}

response = requests.delete(url, headers=headers, data=json.dumps(data))

print(response.json())

Response:

{
  "status": "File deleted successfully."
}

{
  "error": "Document does not exist"
}

Key Notes:

Replace <your-collection-name> with the actual name of your collection.
Replace <your-api-key> with your actual API key.
Replace <your-doc-id> with your actual document id.

4. Delete collection

DELETE https://sso.raen.ai/collections/{collection-name}

curl -X 'DELETE' \
  'https://sso.raen.ai/collections/<you-collection-name>' \
  -H 'accept: application/json' \
  -H 'X-API-Key: <you-api-key>'

import requests

# Replace with actual values
collection_name = "<your-collection-name>"
api_key = "<your-api-key>"

url = f'https://sso.raen.ai/collections/{collection_name}'
headers = {
    'accept': 'application/json',
    'X-API-Key': api_key 
}

response = requests.delete(url, headers=headers)

print(response.json())

{
  "status": "Collection deleted successfully."
}

{
  "error": "Collection does not exist"
}

Key Notes:

Replace <your-collection-name> with the actual name of your collection.
Replace <your-api-key> with your actual API key.

5. Download a specific file

GET https://sso.raen.ai/collections/files/{collection-name}/{document-id}


curl -X 'GET' \
  'https://sso.raen.ai/collections/files/<your-collection-name>/<document-id>' \
  -H 'accept: application/json' \
  -H 'X-API-Key: <your-api-key>'

import requests

# Replace with actual values
collection_name = "<your-collection-name>"
document_id = <your-document-id>
api_key = "<your-api-key>"

url = f"https://sso.raen.ai/collections/files/{collection_name}/{document_id}"
headers = {
    "accept": "application/json",
    "X-API-Key": api_key
}

response = requests.get(url, headers=headers)

print(response.json())

Response:

{
    "download_url": <presigned_url>,
    "expires_in": 3600,
    "document_id": <document-id>,
    "filename": <file-name>
}

{
    "error":"Failed to generate download URL"
}

{
    "error":"Document not found"
}

Key Notes:

Replace <your-collection-name> with the actual name of your collection.
Replace <your-api-key> with your actual API key.
Replace <your-document-id> with your actual document id.

6. Get all collections

GET https://sso.raen.ai/collections/

curl -X 'GET' \
  'https://sso.raen.ai/collections/' \
  -H 'accept: application/json' \
  -H 'X-API-Key: <yor-api-key>'

import requests

url = "https://sso.raen.ai/collections/"


headers = {
    "accept": "application/json",
    "X-API-Key": "<your-api-key>"  # Replace with your actual API key
}

response = requests.get(url, headers=headers)

# Print response
print("Response:", response)

Response:

[
  {
    "id": <collection_id>,
    "user_id": <user_id>,
    "name": "<collection_name>",
    "created_on": "<timestamp>",
    "last_updated": "<timestamp>",
    "documents": [
      {
        "id": <document_id>,
        "user_id": <user_id>,
        "type": "<file_type>",
        "name": "<file_name>",
        "size_bytes": <file_size>,
        "created_on": "<timestamp>",
        "updated_on": "<timestamp>"
      }
    ]
  }
]

{
    "error":"Collection not found."
}

Key Notes:

Replace <your-api-key> with your actual API key.

PreviousNeoAthena Web UI NextPython SDK Guide

Last updated 6 months ago

Was this helpful?