RAGaaS Logo

Namespaces API Reference

Learn about the namespace management endpoints and how to configure your infrastructure settings.

Namespaces are isolated environments with their own storage, vector database, and embedding model configurations.

POST/v1/namespaces

Create Namespace

Create a new namespace with storage and model configurations.

Authorization

  • Name
    Authorization*
    Type
    string
    Description
    Bearer token authentication. Include your API key as Bearer your_api_key

Request Body

  • Name
    name*
    Type
    string
    Description
    Name of the namespace
  • Name
    fileStorageConfig*
    Type
    object
    Description
    File storage configuration for the namespace. All the raw and parsed files will be stored here.
    • Name
      type*
      Type
      enum<string>
      Description
      Type of file storage. Currently only S3 compatible file storages are supported.
      Available options: S3_COMPATIBLE
    • Name
      bucket*
      Type
      string
      Description
      Bucket name in your file storage where files are stored
    • Name
      region*
      Type
      string
      Description
      Region where your file storage is located
    • Name
      endpoint*
      Type
      string
      Description
      Endpoint URL of your file storage
    • Name
      credentials*
      Type
      object
      Description
      Credentials of your file storage
      • Name
        accessKeyId*
        Type
        string
        Description
        Access key ID of your file storage
      • Name
        secretAccessKey*
        Type
        string
        Description
        Secret access key of your file storage
  • Name
    vectorStorageConfig*
    Type
    object
    Description
    Vector storage configuration for the namespace. All the vector embeddings will be stored here.
    • Name
      provider*
      Type
      enum<string>
      Description
      Provider of the vector storage. Currently only Pinecone is supported.
      Available options: PINECONE
    • Name
      apiKey*
      Type
      string
      Description
      API key of the vector storage
    • Name
      indexHost*
      Type
      string
      Description
      Host URL of the vector storage index
  • Name
    embeddingModelConfig*
    Type
    object
    Description
    Embedding model configuration for the namespace. This configuration is used to generate vector embeddings for the documents.
    • Name
      provider*
      Type
      enum<string>
      Description
      Provider of the embedding model. Currently only OPENAI, COHERE and JINA are supported.
      Available options: OPENAI, COHERE, JINA
    • Name
      model*
      Type
      string
      Description
      Name of the embedding model. See supported models.
    • Name
      apiKey*
      Type
      string
      Description
      API key of the embedding model provider. OPENAI / COHERE / JINA api key if you use any OPENAI / COHERE / JINA embedding model respectively.
  • Name
    webScraperConfig
    Type
    object(optional)
    Description
    Web scraper configuration for the namespace. This configuration is used to scrape content from websites.
    • Name
      provider*
      Type
      enum<string>
      Description
      Provider of the web scraper. Currently only PINECONE is supported.
      Available options: PINECONE
    • Name
      apiKey*
      Type
      string
      Description
      API key of the web scraper provider. PINECONE api key if you use PINECONE web scraper.

Request

POST
/v1/namespaces
curl -X POST https://api.ragaas.dev/v1/namespaces \
  -H "Authorization: Bearer $RAGAAS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "production",
    "fileStorageConfig": {
      "type": "S3_COMPATIBLE",
      "bucket": "your-bucket",
      "region": "us-east-1",
      "endpoint": "your-endpoint-url",
      "credentials": {
        "accessKeyId": "your-access-key-id",
        "secretAccessKey": "your-secret-access-key"
      }
    },
    "vectorStorageConfig": {
      "provider": "PINECONE",
      "apiKey": "your-pinecone-api-key",
      "indexHost": "your-index-host"
    },
    "embeddingModelConfig": {
      "provider": "OPENAI",
      "model": "text-embedding-3-small",
      "apiKey": "your-openai-api-key"
    },
    "webScraperConfig": {
      "provider": "FIRECRAWL",
      "apiKey": "your-firecrawl-api-key"
    }
  }'


Response Body

  • Name
    success*
    Type
    boolean
    Description
    Indicates whether the request is successful or not. This is always true for success responses.
  • Name
    message*
    Type
    string
    Description
    Human readable message mentioning the result of the request
  • Name
    data*
    Type
    object
    Description
    Data returned from the API.
    • Name
      id*
      Type
      string
      Description
      Unique identifier for the namespace
    • Name
      name*
      Type
      string
      Description
      Name of the namespace
    • Name
      organization*
      Type
      object
      Description
      Organization that the namespace belongs to
      • Name
        id*
        Type
        string
        Description
        Unique identifier for the organization
    • Name
      fileStorageConfig*
      Type
      object
      Description
      File storage configuration for the namespace. All the raw and parsed files will be stored here.
      • Name
        type*
        Type
        enum<string>
        Description
        Type of file storage. Currently only S3 compatible file storages are supported.
        Available options: S3_COMPATIBLE
      • Name
        bucket*
        Type
        string
        Description
        Bucket name in your file storage where files are stored
      • Name
        region*
        Type
        string
        Description
        Region where your file storage is located
      • Name
        endpoint*
        Type
        string
        Description
        Endpoint URL of your file storage
      • Name
        credentials*
        Type
        object
        Description
        Credentials of your file storage
        • Name
          accessKeyId*
          Type
          string
          Description
          Access key ID of your file storage
        • Name
          secretAccessKey*
          Type
          string
          Description
          Secret access key of your file storage
    • Name
      vectorStorageConfig*
      Type
      object
      Description
      Vector storage configuration for the namespace. All the vector embeddings will be stored here.
      • Name
        provider*
        Type
        enum<string>
        Description
        Provider of the vector storage. Currently only Pinecone is supported.
        Available options: PINECONE
      • Name
        apiKey*
        Type
        string
        Description
        API key of the vector storage
      • Name
        indexHost*
        Type
        string
        Description
        Host URL of the vector storage index
    • Name
      embeddingModelConfig*
      Type
      object
      Description
      Embedding model configuration for the namespace. This configuration is used to generate vector embeddings for the documents.
      • Name
        provider*
        Type
        enum<string>
        Description
        Provider of the embedding model. Currently only OPENAI, COHERE and JINA are supported.
        Available options: OPENAI, COHERE, JINA
      • Name
        model*
        Type
        string
        Description
        Name of the embedding model. See supported models.
      • Name
        apiKey*
        Type
        string
        Description
        API key of the embedding model provider. OPENAI / COHERE / JINA api key if you use any OPENAI / COHERE / JINA embedding model respectively.
    • Name
      webScraperConfig
      Type
      object(optional)
      Description
      Web scraper configuration for the namespace. This configuration is used to scrape content from websites.
      • Name
        provider*
        Type
        enum<string>
        Description
        Provider of the web scraper. Currently only PINECONE is supported.
        Available options: PINECONE
      • Name
        apiKey*
        Type
        string
        Description
        API key of the web scraper provider. PINECONE api key if you use PINECONE web scraper.
    • Name
      notionConfig
      Type
      object(optional)
      Description
      Notion configuration for the namespace.
      • Name
        clientId*
        Type
        string
        Description
        Client ID of the Notion integration
      • Name
        clientSecret*
        Type
        string
        Description
        Client secret of the Notion integration
    • Name
      googleDriveConfig
      Type
      object(optional)
      Description
      Google Drive configuration for the namespace.
      • Name
        clientId*
        Type
        string
        Description
        Client ID of the Google Drive integration
      • Name
        clientSecret*
        Type
        string
        Description
        Client secret of the Google Drive integration
      • Name
        apiKey*
        Type
        string
        Description
        API key of the Google Drive integration
    • Name
      dropboxConfig
      Type
      object(optional)
      Description
      Dropbox configuration for the namespace.
      • Name
        clientId*
        Type
        string
        Description
        App key of the Dropbox app that will be used for this integration
      • Name
        clientSecret*
        Type
        string
        Description
        App secret of the Dropbox app that will be used for this integration
    • Name
      onedriveConfig
      Type
      object(optional)
      Description
      OneDrive configuration for the namespace.
      • Name
        clientId*
        Type
        string
        Description
        Client ID of the Azure app that will be used for this integration
      • Name
        clientSecret*
        Type
        string
        Description
        Client secret of the Azure app that will be used for this integration
    • Name
      createdAt*
      Type
      object
      Description
      Timestamp when the namespace was created
      • Name
        isoString*
        Type
        string
        Description
        ISO 8601 formatted timestamp
    • Name
      updatedAt*
      Type
      object
      Description
      Timestamp when the namespace was last updated
      • Name
        isoString*
        Type
        string
        Description
        ISO 8601 formatted timestamp

Response

POST
/v1/namespaces
{
 "success": true,
 "message": "Created namespace successfully",
 "data": {
   "namespace": {
     "id": "ns_123",
     "name": "production",
     "organization": {
       "id": "org_123"
     },
     "fileStorageConfig": {
       "type": "S3_COMPATIBLE",
       "bucket": "your-bucket",
       "region": "us-east-1",
       "endpoint": "https://your-endpoint"
     },
     "vectorStorageConfig": {
       "provider": "PINECONE",
       "indexHost": "your-index-host"
     },
     "embeddingModelConfig": {
       "provider": "OPENAI",
       "model": "text-embedding-3-small"
     },
     "webScraperConfig": {
       "provider": "FIRECRAWL",
       "apiKey": "your-firecrawl-api-key"
     },
     "createdAt": {
       "isoString": "2024-01-01T00:00:00Z"
     },
     "updatedAt": {
       "isoString": "2024-01-01T00:00:00Z"
     }
   }
 }
}
GET/v1/namespaces

List Namespaces

List all namespaces in the organization.

Authorization

  • Name
    Authorization*
    Type
    string
    Description
    Bearer token authentication. Include your API key as Bearer your_api_key

Request

GET
/v1/namespaces
curl -X GET https://api.ragaas.dev/v1/namespaces \
     -H "Authorization: Bearer $RAGAAS_API_KEY"


Response Body

  • Name
    success*
    Type
    boolean
    Description
    Indicates whether the request is successful or not. This is always true for success responses.
  • Name
    message*
    Type
    string
    Description
    Human readable message mentioning the result of the request
  • Name
    data*
    Type
    object
    Description
    Data returned from the API.
    • Name
      namespaces*
      Type
      array<object>
      Description
      List of namespaces in the organization
      • Name
        id*
        Type
        string
        Description
        Unique identifier for the namespace
      • Name
        name*
        Type
        string
        Description
        Name of the namespace
      • Name
        organization*
        Type
        object
        Description
        Organization that the namespace belongs to
        • Name
          id*
          Type
          string
          Description
          Unique identifier for the organization
      • Name
        fileStorageConfig*
        Type
        object
        Description
        File storage configuration for the namespace. All the raw and parsed files will be stored here.
        • Name
          type*
          Type
          enum<string>
          Description
          Type of file storage. Currently only S3 compatible file storages are supported.
          Available options: S3_COMPATIBLE
        • Name
          bucket*
          Type
          string
          Description
          Bucket name in your file storage where files are stored
        • Name
          region*
          Type
          string
          Description
          Region where your file storage is located
        • Name
          endpoint*
          Type
          string
          Description
          Endpoint URL of your file storage
        • Name
          credentials*
          Type
          object
          Description
          Credentials of your file storage
          • Name
            accessKeyId*
            Type
            string
            Description
            Access key ID of your file storage
          • Name
            secretAccessKey*
            Type
            string
            Description
            Secret access key of your file storage
      • Name
        vectorStorageConfig*
        Type
        object
        Description
        Vector storage configuration for the namespace. All the vector embeddings will be stored here.
        • Name
          provider*
          Type
          enum<string>
          Description
          Provider of the vector storage. Currently only Pinecone is supported.
          Available options: PINECONE
        • Name
          apiKey*
          Type
          string
          Description
          API key of the vector storage
        • Name
          indexHost*
          Type
          string
          Description
          Host URL of the vector storage index
      • Name
        embeddingModelConfig*
        Type
        object
        Description
        Embedding model configuration for the namespace. This configuration is used to generate vector embeddings for the documents.
        • Name
          provider*
          Type
          enum<string>
          Description
          Provider of the embedding model. Currently only OPENAI, COHERE and JINA are supported.
          Available options: OPENAI, COHERE, JINA
        • Name
          model*
          Type
          string
          Description
          Name of the embedding model. See supported models.
        • Name
          apiKey*
          Type
          string
          Description
          API key of the embedding model provider. OPENAI / COHERE / JINA api key if you use any OPENAI / COHERE / JINA embedding model respectively.
      • Name
        webScraperConfig
        Type
        object(optional)
        Description
        Web scraper configuration for the namespace. This configuration is used to scrape content from websites.
        • Name
          provider*
          Type
          enum<string>
          Description
          Provider of the web scraper. Currently only PINECONE is supported.
          Available options: PINECONE
        • Name
          apiKey*
          Type
          string
          Description
          API key of the web scraper provider. PINECONE api key if you use PINECONE web scraper.
      • Name
        notionConfig
        Type
        object(optional)
        Description
        Notion configuration for the namespace.
        • Name
          clientId*
          Type
          string
          Description
          Client ID of the Notion integration
        • Name
          clientSecret*
          Type
          string
          Description
          Client secret of the Notion integration
      • Name
        googleDriveConfig
        Type
        object(optional)
        Description
        Google Drive configuration for the namespace.
        • Name
          clientId*
          Type
          string
          Description
          Client ID of the Google Drive integration
        • Name
          clientSecret*
          Type
          string
          Description
          Client secret of the Google Drive integration
        • Name
          apiKey*
          Type
          string
          Description
          API key of the Google Drive integration
      • Name
        dropboxConfig
        Type
        object(optional)
        Description
        Dropbox configuration for the namespace.
        • Name
          clientId*
          Type
          string
          Description
          App key of the Dropbox app that will be used for this integration
        • Name
          clientSecret*
          Type
          string
          Description
          App secret of the Dropbox app that will be used for this integration
      • Name
        onedriveConfig
        Type
        object(optional)
        Description
        OneDrive configuration for the namespace.
        • Name
          clientId*
          Type
          string
          Description
          Client ID of the Azure app that will be used for this integration
        • Name
          clientSecret*
          Type
          string
          Description
          Client secret of the Azure app that will be used for this integration
      • Name
        createdAt*
        Type
        object
        Description
        Timestamp when the namespace was created
        • Name
          isoString*
          Type
          string
          Description
          ISO 8601 formatted timestamp
      • Name
        updatedAt*
        Type
        object
        Description
        Timestamp when the namespace was last updated
        • Name
          isoString*
          Type
          string
          Description
          ISO 8601 formatted timestamp

Response

GET
/v1/namespaces
{
 "success": true,
 "message": "Fetched all the namespaces successfully",
 "data": {
   "namespaces": [
     {
       "id": "ns_123",
       "name": "production",
       "organization": {
         "id": "org_123"
       },
       "fileStorageConfig": {
         "type": "S3_COMPATIBLE",
         "bucket": "your-bucket",
         "region": "us-east-1",
         "endpoint": "https://your-endpoint"
       },
       "vectorStorageConfig": {
         "provider": "PINECONE",
         "indexHost": "your-index-host"
       },
       "embeddingModelConfig": {
         "provider": "OPENAI",
         "model": "text-embedding-3-small"
       },
       "webScraperConfig": {
         "provider": "FIRECRAWL",
         "apiKey": "your-firecrawl-api-key"
       },
       "notionConfig": {
         "clientId": "your-notion-client-id",
         "clientSecret": "your-notion-client-secret"
       },
       "googleDriveConfig": {
         "clientId": "your-google-drive-client-id",
         "clientSecret": "your-google-drive-client-secret",
         "apiKey": "your-google-drive-api-key"
       },
       "dropboxConfig": {
         "clientId": "your-dropbox-app-key",
         "clientSecret": "your-dropbox-app-secret"
       },
       "onedriveConfig": {
         "clientId": "your-azure-client-id",
         "clientSecret": "your-azure-client-secret"
       },
       "createdAt": {
         "isoString": "2024-01-01T00:00:00Z"
       },
       "updatedAt": {
         "isoString": "2024-01-01T00:00:00Z"
       }
     }
   ]
 }
}
GET/v1/namespaces/:id

Get Namespace

Fetch the details of a namespace by its ID.

Authorization

  • Name
    Authorization*
    Type
    string
    Description
    Bearer token authentication. Include your API key as Bearer your_api_key

Path Parameters

  • Name
    namespace_id*
    Type
    string
    Description
    Unique identifier for the namespace

Request

GET
/v1/namespaces/:id
curl -X GET https://api.ragaas.dev/v1/namespaces/ns_123 \
     -H "Authorization: Bearer $RAGAAS_API_KEY"


Response Body

  • Name
    success*
    Type
    boolean
    Description
    Indicates whether the request is successful or not. This is always true for success responses.
  • Name
    message*
    Type
    string
    Description
    Human readable message mentioning the result of the request
  • Name
    data*
    Type
    object
    Description
    Data returned from the API.
    • Name
      namespaces*
      Type
      array<object>
      Description
      List of namespaces in the organization
      • Name
        id*
        Type
        string
        Description
        Unique identifier for the namespace
      • Name
        name*
        Type
        string
        Description
        Name of the namespace
      • Name
        organization*
        Type
        object
        Description
        Organization that the namespace belongs to
        • Name
          id*
          Type
          string
          Description
          Unique identifier for the organization
      • Name
        fileStorageConfig*
        Type
        object
        Description
        File storage configuration for the namespace. All the raw and parsed files will be stored here.
        • Name
          type*
          Type
          enum<string>
          Description
          Type of file storage. Currently only S3 compatible file storages are supported.
          Available options: S3_COMPATIBLE
        • Name
          bucket*
          Type
          string
          Description
          Bucket name in your file storage where files are stored
        • Name
          region*
          Type
          string
          Description
          Region where your file storage is located
        • Name
          endpoint*
          Type
          string
          Description
          Endpoint URL of your file storage
        • Name
          credentials*
          Type
          object
          Description
          Credentials of your file storage
          • Name
            accessKeyId*
            Type
            string
            Description
            Access key ID of your file storage
          • Name
            secretAccessKey*
            Type
            string
            Description
            Secret access key of your file storage
      • Name
        vectorStorageConfig*
        Type
        object
        Description
        Vector storage configuration for the namespace. All the vector embeddings will be stored here.
        • Name
          provider*
          Type
          enum<string>
          Description
          Provider of the vector storage. Currently only Pinecone is supported.
          Available options: PINECONE
        • Name
          apiKey*
          Type
          string
          Description
          API key of the vector storage
        • Name
          indexHost*
          Type
          string
          Description
          Host URL of the vector storage index
      • Name
        embeddingModelConfig*
        Type
        object
        Description
        Embedding model configuration for the namespace. This configuration is used to generate vector embeddings for the documents.
        • Name
          provider*
          Type
          enum<string>
          Description
          Provider of the embedding model. Currently only OPENAI, COHERE and JINA are supported.
          Available options: OPENAI, COHERE, JINA
        • Name
          model*
          Type
          string
          Description
          Name of the embedding model. See supported models.
        • Name
          apiKey*
          Type
          string
          Description
          API key of the embedding model provider. OPENAI / COHERE / JINA api key if you use any OPENAI / COHERE / JINA embedding model respectively.
      • Name
        webScraperConfig
        Type
        object(optional)
        Description
        Web scraper configuration for the namespace. This configuration is used to scrape content from websites.
        • Name
          provider*
          Type
          enum<string>
          Description
          Provider of the web scraper. Currently only PINECONE is supported.
          Available options: PINECONE
        • Name
          apiKey*
          Type
          string
          Description
          API key of the web scraper provider. PINECONE api key if you use PINECONE web scraper.
      • Name
        notionConfig
        Type
        object(optional)
        Description
        Notion configuration for the namespace.
        • Name
          clientId*
          Type
          string
          Description
          Client ID of the Notion integration
        • Name
          clientSecret*
          Type
          string
          Description
          Client secret of the Notion integration
      • Name
        googleDriveConfig
        Type
        object(optional)
        Description
        Google Drive configuration for the namespace.
        • Name
          clientId*
          Type
          string
          Description
          Client ID of the Google Drive integration
        • Name
          clientSecret*
          Type
          string
          Description
          Client secret of the Google Drive integration
        • Name
          apiKey*
          Type
          string
          Description
          API key of the Google Drive integration
      • Name
        dropboxConfig
        Type
        object(optional)
        Description
        Dropbox configuration for the namespace.
        • Name
          clientId*
          Type
          string
          Description
          App key of the Dropbox app that will be used for this integration
        • Name
          clientSecret*
          Type
          string
          Description
          App secret of the Dropbox app that will be used for this integration
      • Name
        onedriveConfig
        Type
        object(optional)
        Description
        OneDrive configuration for the namespace.
        • Name
          clientId*
          Type
          string
          Description
          Client ID of the Azure app that will be used for this integration
        • Name
          clientSecret*
          Type
          string
          Description
          Client secret of the Azure app that will be used for this integration
      • Name
        createdAt*
        Type
        object
        Description
        Timestamp when the namespace was created
        • Name
          isoString*
          Type
          string
          Description
          ISO 8601 formatted timestamp
      • Name
        updatedAt*
        Type
        object
        Description
        Timestamp when the namespace was last updated
        • Name
          isoString*
          Type
          string
          Description
          ISO 8601 formatted timestamp

Response

GET
/v1/namespaces
{
 "success": true,
 "message": "Fetched namespace successfully",
 "data": {
   "namespace": {
     "id": "ns_123",
     "name": "production",
     "organization": {
       "id": "org_123"
     },
     "fileStorageConfig": {
       "type": "S3_COMPATIBLE",
       "bucket": "your-bucket",
       "region": "us-east-1",
       "endpoint": "https://your-endpoint"
     },
     "vectorStorageConfig": {
       "provider": "PINECONE",
       "indexHost": "your-index-host"
     },
     "embeddingModelConfig": {
       "provider": "OPENAI",
       "model": "text-embedding-3-small"
     },
     "webScraperConfig": {
       "provider": "FIRECRAWL",
       "apiKey": "your-firecrawl-api-key"
     },
     "notionConfig": {
       "clientId": "your-notion-client-id",
       "clientSecret": "your-notion-client-secret"
     },
     "googleDriveConfig": {
       "clientId": "your-google-drive-client-id",
       "clientSecret": "your-google-drive-client-secret",
       "apiKey": "your-google-drive-api-key"
     },
     "dropboxConfig": {
       "clientId": "your-dropbox-app-key",
       "clientSecret": "your-dropbox-app-secret"
     },
     "onedriveConfig": {
       "clientId": "your-azure-client-id",
       "clientSecret": "your-azure-client-secret"
     },
     "createdAt": {
       "isoString": "2024-01-01T00:00:00Z"
     },
     "updatedAt": {
       "isoString": "2024-01-01T00:00:00Z"
     }
   }
 }
}
PATCH/v1/namespaces/:id

Update Namespace

Update an existing namespace.

Authorization

  • Name
    Authorization*
    Type
    string
    Description
    Bearer token authentication. Include your API key as Bearer your_api_key

Path Parameters

  • Name
    namespace_id*
    Type
    string
    Description
    Unique identifier for the namespace

Request Body

  • Name
    name
    Type
    string(optional)
    Description
    Name of the namespace
  • Name
    fileStorageConfig
    Type
    object(optional)
    Description
    File storage configuration for the namespace. All the raw and parsed files will be stored here.
    • Name
      type*
      Type
      enum<string>
      Description
      Type of file storage. Currently only S3 compatible file storages are supported.
      Available options: S3_COMPATIBLE
    • Name
      bucket*
      Type
      string
      Description
      Bucket name in your file storage where files are stored
    • Name
      region*
      Type
      string
      Description
      Region where your file storage is located
    • Name
      endpoint*
      Type
      string
      Description
      Endpoint URL of your file storage
    • Name
      credentials*
      Type
      object
      Description
      Credentials of your file storage
      • Name
        accessKeyId*
        Type
        string
        Description
        Access key ID of your file storage
      • Name
        secretAccessKey*
        Type
        string
        Description
        Secret access key of your file storage
  • Name
    vectorStorageConfig
    Type
    object(optional)
    Description
    Vector storage configuration for the namespace. All the vector embeddings will be stored here.
    • Name
      provider*
      Type
      enum<string>
      Description
      Provider of the vector storage. Currently only Pinecone is supported.
      Available options: PINECONE
    • Name
      apiKey*
      Type
      string
      Description
      API key of the vector storage
    • Name
      indexHost*
      Type
      string
      Description
      Host URL of the vector storage index
  • Name
    embeddingModelConfig
    Type
    object(optional)
    Description
    Embedding model configuration for the namespace. This configuration is used to generate vector embeddings for the documents.
    • Name
      provider*
      Type
      enum<string>
      Description
      Provider of the embedding model. Currently only OPENAI, COHERE and JINA are supported.
      Available options: OPENAI, COHERE, JINA
    • Name
      model*
      Type
      string
      Description
      Name of the embedding model. See supported models.
    • Name
      apiKey*
      Type
      string
      Description
      API key of the embedding model provider. OPENAI / COHERE / JINA api key if you use any OPENAI / COHERE / JINA embedding model respectively.
  • Name
    webScraperConfig
    Type
    object(optional)
    Description
    Web scraper configuration for the namespace. This configuration is used to scrape content from websites.
    • Name
      provider*
      Type
      enum<string>
      Description
      Provider of the web scraper. Currently only PINECONE is supported.
      Available options: PINECONE
    • Name
      apiKey*
      Type
      string
      Description
      API key of the web scraper provider. PINECONE api key if you use PINECONE web scraper.
  • Name
    notionConfig
    Type
    object(optional)
    Description
    Notion configuration for the namespace.
    • Name
      clientId*
      Type
      string
      Description
      Client ID of the Notion integration
    • Name
      clientSecret*
      Type
      string
      Description
      Client secret of the Notion integration
  • Name
    googleDriveConfig
    Type
    object(optional)
    Description
    Google Drive configuration for the namespace.
    • Name
      clientId*
      Type
      string
      Description
      Client ID of the Google Drive integration
    • Name
      clientSecret*
      Type
      string
      Description
      Client secret of the Google Drive integration
    • Name
      apiKey*
      Type
      string
      Description
      API key of the Google Drive integration
  • Name
    dropboxConfig
    Type
    object(optional)
    Description
    Dropbox configuration for the namespace.
    • Name
      clientId*
      Type
      string
      Description
      App key of the Dropbox app that will be used for this integration
    • Name
      clientSecret*
      Type
      string
      Description
      App secret of the Dropbox app that will be used for this integration
  • Name
    onedriveConfig
    Type
    object(optional)
    Description
    OneDrive configuration for the namespace.
    • Name
      clientId*
      Type
      string
      Description
      Client ID of the Azure app that will be used for this integration
    • Name
      clientSecret*
      Type
      string
      Description
      Client secret of the Azure app that will be used for this integration

Request

PATCH
/v1/namespaces/:id
curl -X PATCH https://api.ragaas.dev/v1/namespaces/ns_123 \
     -H "Authorization: Bearer $RAGAAS_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
        "name": "updated-name",
        "fileStorageConfig": {
          "type": "S3_COMPATIBLE",
          "bucket": "your-new-bucket",
          "region": "us-east-1",
          "endpoint": "https://your-new-endpoint",
          "credentials": {
            "accessKeyId": "your-new-access-key-id",
            "secretAccessKey": "your-new-secret-access-key"
          }
        },
        "vectorStorageConfig": {
          "provider": "PINECONE",
          "apiKey": "your-new-pinecone-api-key",
          "indexHost": "your-new-index-host"
        },
        "embeddingModelConfig": {
          "provider": "OPENAI",
          "model": "text-embedding-3-large",
          "apiKey": "your-new-openai-api-key"
        },
        "webScraperConfig": {
          "provider": "FIRECRAWL",
          "apiKey": "your-new-firecrawl-api-key"
        },
        "notionConfig": {
          "clientId": "your-notion-oauth-app-client-id",
          "clientSecret": "your-notion-oauth-app-client-secret",
          "authorizationUrl": "https://your-notion-oauth-app-authorization-url"
        },
        "googleDriveConfig": {
          "clientId": "your-google-drive-client-id",
          "clientSecret": "your-google-drive-client-secret",
          "apiKey": "your-google-drive-api-key"
        },
        "dropboxConfig": {
          "clientId": "your-dropbox-app-key",
          "clientSecret": "your-dropbox-app-secret",
        },
        "onedriveConfig": {
          "clientId": "your-azure-client-id",
          "clientSecret": "your-azure-client-secret"
        }
     }'


Response Body

  • Name
    success*
    Type
    boolean
    Description
    Indicates whether the request is successful or not. This is always true for success responses.
  • Name
    message*
    Type
    string
    Description
    Human readable message mentioning the result of the request
  • Name
    data*
    Type
    object
    Description
    Data returned from the API.
    • Name
      id*
      Type
      string
      Description
      Unique identifier for the namespace
    • Name
      name*
      Type
      string
      Description
      Name of the namespace
    • Name
      organization*
      Type
      object
      Description
      Organization that the namespace belongs to
      • Name
        id*
        Type
        string
        Description
        Unique identifier for the organization
    • Name
      fileStorageConfig*
      Type
      object
      Description
      File storage configuration for the namespace. All the raw and parsed files will be stored here.
      • Name
        type*
        Type
        enum<string>
        Description
        Type of file storage. Currently only S3 compatible file storages are supported.
        Available options: S3_COMPATIBLE
      • Name
        bucket*
        Type
        string
        Description
        Bucket name in your file storage where files are stored
      • Name
        region*
        Type
        string
        Description
        Region where your file storage is located
      • Name
        endpoint*
        Type
        string
        Description
        Endpoint URL of your file storage
      • Name
        credentials*
        Type
        object
        Description
        Credentials of your file storage
        • Name
          accessKeyId*
          Type
          string
          Description
          Access key ID of your file storage
        • Name
          secretAccessKey*
          Type
          string
          Description
          Secret access key of your file storage
    • Name
      vectorStorageConfig*
      Type
      object
      Description
      Vector storage configuration for the namespace. All the vector embeddings will be stored here.
      • Name
        provider*
        Type
        enum<string>
        Description
        Provider of the vector storage. Currently only Pinecone is supported.
        Available options: PINECONE
      • Name
        apiKey*
        Type
        string
        Description
        API key of the vector storage
      • Name
        indexHost*
        Type
        string
        Description
        Host URL of the vector storage index
    • Name
      embeddingModelConfig*
      Type
      object
      Description
      Embedding model configuration for the namespace. This configuration is used to generate vector embeddings for the documents.
      • Name
        provider*
        Type
        enum<string>
        Description
        Provider of the embedding model. Currently only OPENAI, COHERE and JINA are supported.
        Available options: OPENAI, COHERE, JINA
      • Name
        model*
        Type
        string
        Description
        Name of the embedding model. See supported models.
      • Name
        apiKey*
        Type
        string
        Description
        API key of the embedding model provider. OPENAI / COHERE / JINA api key if you use any OPENAI / COHERE / JINA embedding model respectively.
    • Name
      webScraperConfig
      Type
      object(optional)
      Description
      Web scraper configuration for the namespace. This configuration is used to scrape content from websites.
      • Name
        provider*
        Type
        enum<string>
        Description
        Provider of the web scraper. Currently only PINECONE is supported.
        Available options: PINECONE
      • Name
        apiKey*
        Type
        string
        Description
        API key of the web scraper provider. PINECONE api key if you use PINECONE web scraper.
    • Name
      notionConfig
      Type
      object(optional)
      Description
      Notion configuration for the namespace.
      • Name
        clientId*
        Type
        string
        Description
        Client ID of the Notion integration
      • Name
        clientSecret*
        Type
        string
        Description
        Client secret of the Notion integration
    • Name
      googleDriveConfig
      Type
      object(optional)
      Description
      Google Drive configuration for the namespace.
      • Name
        clientId*
        Type
        string
        Description
        Client ID of the Google Drive integration
      • Name
        clientSecret*
        Type
        string
        Description
        Client secret of the Google Drive integration
      • Name
        apiKey*
        Type
        string
        Description
        API key of the Google Drive integration
    • Name
      dropboxConfig
      Type
      object(optional)
      Description
      Dropbox configuration for the namespace.
      • Name
        clientId*
        Type
        string
        Description
        App key of the Dropbox app that will be used for this integration
      • Name
        clientSecret*
        Type
        string
        Description
        App secret of the Dropbox app that will be used for this integration
    • Name
      onedriveConfig
      Type
      object(optional)
      Description
      OneDrive configuration for the namespace.
      • Name
        clientId*
        Type
        string
        Description
        Client ID of the Azure app that will be used for this integration
      • Name
        clientSecret*
        Type
        string
        Description
        Client secret of the Azure app that will be used for this integration
    • Name
      createdAt*
      Type
      object
      Description
      Timestamp when the namespace was created
      • Name
        isoString*
        Type
        string
        Description
        ISO 8601 formatted timestamp
    • Name
      updatedAt*
      Type
      object
      Description
      Timestamp when the namespace was last updated
      • Name
        isoString*
        Type
        string
        Description
        ISO 8601 formatted timestamp

Response

PATCH
/v1/namespaces/:id
{
  "success": true,
  "message": "Updated namespace successfully",
  "data": {
    "namespace": {
      "id": "ns_123",
      "name": "updated-name",
      "organization": {
        "id": "org_123"
      },
      "fileStorageConfig": {
        "type": "S3_COMPATIBLE",
        "bucket": "your-new-bucket",
        "region": "us-east-1",
        "endpoint": "https://your-new-endpoint"
      },
      "vectorStorageConfig": {
        "provider": "PINECONE",
        "indexHost": "your-new-index-host"
      },
      "embeddingModelConfig": {
        "provider": "OPENAI",
        "model": "text-embedding-3-large"
      },
      "webScraperConfig": {
        "provider": "FIRECRAWL",
        "apiKey": "your-new-firecrawl-api-key"
      },
      "notionConfig": {
        "clientId": "your-new-notion-oauth-app-client-id",
        "clientSecret": "your-new-notion-oauth-app-client-secret",
        "authorizationUrl": "https://your-new-notion-oauth-app-authorization-url"
      },
      "googleDriveConfig": {
        "clientId": "your-new-google-drive-client-id",
        "clientSecret": "your-new-google-drive-client-secret",
        "apiKey": "your-new-google-drive-api-key"
      },
      "dropboxConfig": {
        "clientId": "your-new-dropbox-app-key",
        "clientSecret": "your-new-dropbox-app-secret"
      },
      "onedriveConfig": {
        "clientId": "your-new-azure-client-id",
        "clientSecret": "your-new-azure-client-secret"
      },
      "createdAt": {
        "isoString": "2024-01-01T00:00:00Z"
      },
      "updatedAt": {
        "isoString": "2024-01-01T00:00:00Z"
      }
    }
  }
}
DELETE/v1/namespaces/:id

Delete Namespace

Delete a namespace.

Authorization

  • Name
    Authorization*
    Type
    string
    Description
    Bearer token authentication. Include your API key as Bearer your_api_key

Path Parameters

  • Name
    namespace_id*
    Type
    string
    Description
    Unique identifier for the namespace

Request

DELETE
/v1/namespaces/:id
curl -X DELETE https://api.ragaas.dev/v1/namespaces/ns_123 \ 
     -H "Authorization: Bearer $RAGAAS_API_KEY"


Response Body

  • Name
    success*
    Type
    boolean
    Description
    Indicates whether the request is successful or not. This is always true for success responses.
  • Name
    message*
    Type
    string
    Description
    Human readable message mentioning the result of the request
  • Name
    data*
    Type
    object
    Description
    Data returned from the API.
    • Name
      id*
      Type
      string
      Description
      Unique identifier of the deleted namespace

Response

DELETE
/v1/namespaces/:id
{
  "success": true,
  "message": "Deleted namespace successfully",
  "data": {
    "id": "ns_123"
  }
}

Error Codes

  • Name
    NAMESPACE_NOT_FOUND
    Description

    The specified namespace does not exist

  • Name
    INVALID_NAMESPACE_CONFIG
    Description

    Invalid namespace configuration provided

  • Name
    STORAGE_CONFIG_ERROR
    Description

    Error validating storage configuration

  • Name
    VECTOR_DB_CONFIG_ERROR
    Description

    Error validating vector database configuration

  • Name
    EMBEDDING_CONFIG_ERROR
    Description

    Error validating embedding model configuration

  • Name
    NAMESPACE_LIMIT_EXCEEDED
    Description

    Organization namespace limit exceeded

Configuration Requirements

File Storage Configuration

S3-compatible storage configuration options:

interface FileStorageConfig {
  type: 'S3_COMPATIBLE'
  bucket: string // S3 bucket name
  region: string // AWS region or custom region
  endpoint: string // S3-compatible endpoint URL
  credentials: {
    accessKeyId: string
    secretAccessKey: string
  }
}

Vector Storage Configuration

Currently supported vector database configurations:

interface VectorStorageConfig {
  provider: 'PINECONE' // Currently only Pinecone is supported
  apiKey: string // Pinecone API key
  indexHost: string // Pinecone index host URL
}

Embedding Model Configuration

Supported embedding model configurations:

interface EmbeddingModelConfig {
  provider: 'OPENAI' | 'COHERE' | 'JINA'
  model: string // Model name (e.g., "text-embedding-3-small")
  apiKey: string // Provider API key
}

Web Scraper Configuration

Supported web scraper configurations:

interface WebScraperConfig {
  provider: 'FIRECRAWL'
  apiKey: string
}