# Retrieve, Update, or Delete RAG Document

PUT /api/v1/content-vault/documents/{document_id}/
Content-Type: multipart/form-data

Retrieve detailed information about a specific document, update its content, or delete it. All operations are restricted to the document owner.

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

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: AISquare Studio API
  version: 1.0.0
paths:
  /api/v1/content-vault/documents/{document_id}/:
    put:
      operationId: documents-update
      summary: Retrieve, Update, or Delete RAG Document
      description: >-
        Retrieve detailed information about a specific document, update its
        content, or delete it. All operations are restricted to the document
        owner.
      tags:
        - subpackage_contentVault
      parameters:
        - name: document_id
          in: path
          description: Document ID
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Document details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RAGDocumentDetail'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                description: Any type
        '404':
          description: Document not found or not owned by user
          content:
            application/json:
              schema:
                description: Any type
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                document_name:
                  type:
                    - string
                    - 'null'
                document_url:
                  type:
                    - string
                    - 'null'
                content:
                  type:
                    - string
                    - 'null'
                config:
                  oneOf:
                    - description: Any type
                    - type: 'null'
                document_file:
                  type: string
                  format: uri
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
    RAGDocumentDetail:
      type: object
      properties:
        document_id:
          type: integer
        document_name:
          type:
            - string
            - 'null'
        document_type:
          $ref: '#/components/schemas/RAGDocumentTypeEnum'
        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'
        user:
          type: string
        upload_status:
          $ref: '#/components/schemas/UploadStatusEnum'
        has_file:
          type: boolean
        status_message:
          type:
            - string
            - 'null'
          description: Human-readable status / failure message for ingestion
        description:
          type: string
        owner:
          $ref: '#/components/schemas/SimpleUser'
        progress:
          type: integer
          description: Processing progress as percentage (0-100)
      required:
        - document_id
        - created_at
        - updated_at
        - file_type
        - file_size
        - user
        - upload_status
        - has_file
        - status_message
        - description
        - owner
        - progress
      description: Serializer for detailed document view
      title: RAGDocumentDetail

```

## SDK Code Examples

```python
import requests

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

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_url\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"config\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = {"Content-Type": "multipart/form-data; boundary=---011000010111000001101001"}

response = requests.put(url, data=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/api/v1/content-vault/documents/1/';
const form = new FormData();
form.append('document_name', '');
form.append('document_url', '');
form.append('content', '');
form.append('config', '');
form.append('document_file', '');

const options = {method: 'PUT'};

options.body = form;

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/1/"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_url\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"config\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")

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

	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/1/")

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

request = Net::HTTP::Put.new(url)
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_url\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"config\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"

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.put("https://api.example.com/api/v1/content-vault/documents/1/")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_url\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"config\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.example.com/api/v1/content-vault/documents/1/', [
  'headers' => [
    'Content-Type' => 'multipart/form-data; boundary=---011000010111000001101001',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/api/v1/content-vault/documents/1/");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "multipart/form-data; boundary=---011000010111000001101001");
request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_url\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"config\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation
let parameters = [
  [
    "name": "document_name",
    "value": 
  ],
  [
    "name": "document_url",
    "value": 
  ],
  [
    "name": "content",
    "value": 
  ],
  [
    "name": "config",
    "value": 
  ],
  [
    "name": "document_file",
    "value": 
  ]
]

let boundary = "---011000010111000001101001"

var body = ""
var error: NSError? = nil
for param in parameters {
  let paramName = param["name"]!
  body += "--\(boundary)\r\n"
  body += "Content-Disposition:form-data; name=\"\(paramName)\""
  if let filename = param["fileName"] {
    let contentType = param["content-type"]!
    let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)
    if (error != nil) {
      print(error as Any)
    }
    body += "; filename=\"\(filename)\"\r\n"
    body += "Content-Type: \(contentType)\r\n\r\n"
    body += fileContent
  } else if let paramValue = param["value"] {
    body += "\r\n\r\n\(paramValue)"
  }
}

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/api/v1/content-vault/documents/1/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
```

```python
import requests

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

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_url\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"config\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = {"Content-Type": "multipart/form-data; boundary=---011000010111000001101001"}

response = requests.put(url, data=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/api/v1/content-vault/documents/1/';
const form = new FormData();
form.append('document_name', '');
form.append('document_url', '');
form.append('content', '');
form.append('config', '');
form.append('document_file', '');

const options = {method: 'PUT'};

options.body = form;

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/1/"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_url\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"config\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")

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

	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/1/")

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

request = Net::HTTP::Put.new(url)
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_url\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"config\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"

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.put("https://api.example.com/api/v1/content-vault/documents/1/")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_url\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"config\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.example.com/api/v1/content-vault/documents/1/', [
  'headers' => [
    'Content-Type' => 'multipart/form-data; boundary=---011000010111000001101001',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/api/v1/content-vault/documents/1/");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "multipart/form-data; boundary=---011000010111000001101001");
request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_url\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"config\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation
let parameters = [
  [
    "name": "document_name",
    "value": 
  ],
  [
    "name": "document_url",
    "value": 
  ],
  [
    "name": "content",
    "value": 
  ],
  [
    "name": "config",
    "value": 
  ],
  [
    "name": "document_file",
    "value": 
  ]
]

let boundary = "---011000010111000001101001"

var body = ""
var error: NSError? = nil
for param in parameters {
  let paramName = param["name"]!
  body += "--\(boundary)\r\n"
  body += "Content-Disposition:form-data; name=\"\(paramName)\""
  if let filename = param["fileName"] {
    let contentType = param["content-type"]!
    let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)
    if (error != nil) {
      print(error as Any)
    }
    body += "; filename=\"\(filename)\"\r\n"
    body += "Content-Type: \(contentType)\r\n\r\n"
    body += fileContent
  } else if let paramValue = param["value"] {
    body += "\r\n\r\n\(paramValue)"
  }
}

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/api/v1/content-vault/documents/1/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
```