# List and Create RAG Documents

GET /api/v1/content-vault/documents/

List all RAG documents for the authenticated user with pagination. Supports search, filtering and multiple ordering patterns. POST supports creating new documents with file upload capabilities.

Reference: https://docs.aisquare.studio/api-reference/ai-square-studio-api/content-vault/documents-list

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: AISquare Studio API
  version: 1.0.0
paths:
  /api/v1/content-vault/documents/:
    get:
      operationId: documents-list
      summary: List and Create RAG Documents
      description: >-
        List all RAG documents for the authenticated user with pagination.
        Supports search, filtering and multiple ordering patterns. POST supports
        creating new documents with file upload capabilities.
      tags:
        - subpackage_contentVault
      parameters:
        - name: file_type
          in: query
          description: Filter by document_type
          required: false
          schema:
            type: string
        - name: ordering
          in: query
          description: >-
            Comma separated ordering fields (updated_at, document_name) prefix
            with - for desc
          required: false
          schema:
            type: string
        - name: page
          in: query
          description: A page number within the paginated result set.
          required: false
          schema:
            type: integer
        - name: page_size
          in: query
          description: Number of results to return per page.
          required: false
          schema:
            type: integer
        - name: q
          in: query
          description: Full-text search across document fields
          required: false
          schema:
            type: string
        - name: sort
          in: query
          description: 'Shortcut ordering: latest | oldest | name_asc | name_desc'
          required: false
          schema:
            type: string
        - name: status
          in: query
          description: Filter by upload_status
          required: false
          schema:
            type: string
      responses:
        '200':
          description: List of user's documents
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRAGDocumentListList'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                description: Any type
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                description: Any type
components:
  schemas:
    RAGDocumentTypeEnum:
      type: string
      enum:
        - file
        - url
        - user
        - text
        - youtube
        - gdrive
        - email
        - rss
      description: |-
        * `file` - File
        * `url` - URL
        * `user` - User
        * `text` - Text
        * `youtube` - YouTube
        * `gdrive` - Google Drive
        * `email` - Email
        * `rss` - RSS Feed
      title: RAGDocumentTypeEnum
    UploadStatusEnum:
      type: string
      enum:
        - importing
        - vectorizing
        - summarizing
        - uploaded
        - failed
      description: |-
        * `importing` - Importing
        * `vectorizing` - Vectorizing
        * `summarizing` - Summarizing
        * `uploaded` - Uploaded
        * `failed` - Failed
      title: UploadStatusEnum
    SimpleUser:
      type: object
      properties:
        id:
          type: integer
        email:
          type: string
          format: email
        full_name:
          type: string
        username:
          type: string
          description: >-
            Required. 150 characters or fewer. Letters, digits and @/./+/-/_
            only.
        is_verified:
          type: boolean
        profile_picture:
          type: string
          format: uri
          description: |-
            Convert ImageFieldFile to URL string for JSON serialization.

            Args:
                obj: The model instance being serialized (typically IAMUser)

            Returns:
                str | None: The URL of the profile picture, or None if not available
      required:
        - id
        - email
        - full_name
        - username
        - is_verified
        - profile_picture
      description: >-
        Simple user serializer with profile picture from associated
        IAMUserDetail.


        Fields:
          - id, email, full_name, username, is_verified (from IAMUser)
          - profile_picture (from first related IAMUserDetail if present)
      title: SimpleUser
    RAGDocumentList:
      type: object
      properties:
        document_id:
          type: integer
        document_name:
          type:
            - string
            - 'null'
        document_type:
          $ref: '#/components/schemas/RAGDocumentTypeEnum'
        document_url:
          type:
            - string
            - 'null'
        content:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        config:
          oneOf:
            - description: Any type
            - type: 'null'
        file_type:
          type:
            - string
            - 'null'
        file_size:
          type:
            - integer
            - 'null'
        upload_status:
          $ref: '#/components/schemas/UploadStatusEnum'
        status_message:
          type:
            - string
            - 'null'
          description: Human-readable status / failure message for ingestion
        linked_experiences_count:
          type: integer
        linked_experiences:
          type: array
          items:
            type: object
            additionalProperties:
              description: Any type
        has_file:
          type: boolean
        description:
          type: string
        workspace:
          type: string
        workspace_id:
          type: integer
        owner:
          $ref: '#/components/schemas/SimpleUser'
          description: Owner/uploader user object
        progress:
          type: integer
          description: Processing progress as percentage (0-100)
      required:
        - document_id
        - created_at
        - updated_at
        - file_type
        - file_size
        - upload_status
        - status_message
        - linked_experiences_count
        - linked_experiences
        - has_file
        - description
        - workspace
        - workspace_id
        - owner
        - progress
      description: Serializer for listing RAG documents with file metadata
      title: RAGDocumentList
    PaginatedRAGDocumentListList:
      type: object
      properties:
        count:
          type: integer
        next:
          type:
            - string
            - 'null'
          format: uri
        previous:
          type:
            - string
            - 'null'
          format: uri
        results:
          type: array
          items:
            $ref: '#/components/schemas/RAGDocumentList'
      required:
        - count
        - results
      title: PaginatedRAGDocumentListList

```

## SDK Code Examples

```python
import requests

url = "https://api.example.com/api/v1/content-vault/documents/"

payload = {}
headers = {"Content-Type": "application/json"}

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

print(response.json())
```

```javascript
const url = 'https://api.example.com/api/v1/content-vault/documents/';
const options = {method: 'GET', headers: {'Content-Type': 'application/json'}, body: '{}'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/content-vault/documents/"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/content-vault/documents/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/content-vault/documents/")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/api/v1/content-vault/documents/', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/api/v1/content-vault/documents/");
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/api/v1/content-vault/documents/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```