# Update a Document

PATCH https://%7BYour_Space_Name%7D.signalwire.com/api/datasphere/documents/{id}
Content-Type: application/json

Updates a Datasphere Document by ID.

#### Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: _DataSphere_.

[Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Reference: https://signalwire.com/docs/apis/datasphere/documents/update-document

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: datasphere
  version: 1.0.0
paths:
  /documents/{id}:
    patch:
      operationId: update-document
      summary: Update a Document
      description: >-
        Updates a Datasphere Document by ID.


        #### Permissions


        The API token used to authenticate must have the following scope(s)
        enabled to make a successful request: _DataSphere_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_documents
      parameters:
        - name: id
          in: path
          description: Unique ID of a Document.
          required: true
          schema:
            $ref: '#/components/schemas/docid'
        - name: Authorization
          in: header
          description: >-
            SignalWire Basic Authentication using Project ID and API Token.


            The client sends HTTP requests with the Authorization header
            containing

            the word Basic followed by a space and a base64-encoded string of
            project_id:token.

            The project ID will be used as the username and the API token as the
            password.


            Example:

            ```

            Authorization: Basic base64(project_id:token)

            ```
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode400'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '422':
          description: The request contains invalid parameters. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateStatusCode422'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentUpdateRequest'
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com/api/datasphere
components:
  schemas:
    docid:
      type: string
      format: uuid
      description: Unique ID of a Document.
      title: docid
    DocumentUpdateRequest:
      type: object
      properties:
        tags:
          type: array
          items:
            type: string
          description: Document tags.
      required:
        - tags
      title: DocumentUpdateRequest
    DocumentStatus:
      type: string
      enum:
        - submitted
        - in_progress
        - completed
        - failed
      description: The current Status of the Document.
      title: DocumentStatus
    ChunkingStrategy:
      type: string
      enum:
        - sentence
        - paragraph
        - page
        - sliding
      description: Strategy to use when chunking the document.
      title: ChunkingStrategy
    Document:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/docid'
          description: Unique ID of the Document.
        filename:
          type: string
          description: Name of the Document.
        status:
          $ref: '#/components/schemas/DocumentStatus'
          description: Status of the Document.
        tags:
          type: array
          items:
            type: string
          description: Document tags.
        chunking_strategy:
          $ref: '#/components/schemas/ChunkingStrategy'
          description: Strategy used to chunk the document.
        max_sentences_per_chunk:
          type:
            - integer
            - 'null'
          description: >-
            Max Sentences per Chunk. Only present when chunking strategy is
            'sentence', null otherwise.
        split_newlines:
          type:
            - boolean
            - 'null'
          description: >-
            Split on Newlines. Only present when chunking strategy is
            'sentence', null otherwise.
        overlap_size:
          type:
            - integer
            - 'null'
          description: >-
            Overlap Size. Only present when chunking strategy is 'sliding', null
            otherwise.
        chunk_size:
          type:
            - integer
            - 'null'
          description: >-
            Chunk Size. Only present when chunking strategy is 'sliding', null
            otherwise.
        number_of_chunks:
          type: integer
          description: Number of Chunks in the Document.
        chunks_uri:
          type: string
          description: URI path to the chunks for this document.
        created_at:
          type: string
          format: date-time
          description: Document Creation Date.
        updated_at:
          type: string
          format: date-time
          description: Document Update Date.
      required:
        - id
        - filename
        - status
        - tags
        - chunking_strategy
        - max_sentences_per_chunk
        - split_newlines
        - overlap_size
        - chunk_size
        - number_of_chunks
        - chunks_uri
        - created_at
        - updated_at
      title: Document
    TypesStatusCodesStatusCode400Error:
      type: string
      enum:
        - Bad Request
      title: TypesStatusCodesStatusCode400Error
    Types.StatusCodes.StatusCode400:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode400Error'
      required:
        - error
      description: The request is invalid.
      title: Types.StatusCodes.StatusCode400
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    TypesStatusCodesStatusCode404Error:
      type: string
      enum:
        - Not Found
      title: TypesStatusCodesStatusCode404Error
    Types.StatusCodes.StatusCode404:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error'
      required:
        - error
      description: The server cannot find the requested resource.
      title: Types.StatusCodes.StatusCode404
    Types.StatusCodes.RestApiErrorItem:
      type: object
      properties:
        type:
          type: string
          description: The category of error.
        code:
          type: string
          description: A specific error code.
        message:
          type: string
          description: A description of what caused the error.
        attribute:
          type:
            - string
            - 'null'
          description: The request parameter that caused the error, if applicable.
        url:
          type: string
          description: A link to documentation about this error.
      required:
        - type
        - code
        - message
        - url
      description: Details about a specific error.
      title: Types.StatusCodes.RestApiErrorItem
    UpdateStatusCode422:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.RestApiErrorItem'
          description: List of validation errors.
      required:
        - errors
      description: The request contains invalid parameters. See errors for details.
      title: UpdateStatusCode422
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        SignalWire Basic Authentication using Project ID and API Token.


        The client sends HTTP requests with the Authorization header containing

        the word Basic followed by a space and a base64-encoded string of
        project_id:token.

        The project ID will be used as the username and the API token as the
        password.


        Example:

        ```

        Authorization: Basic base64(project_id:token)

        ```

```

## SDK Code Examples

```python
import requests

url = "https://{your_space_name}.signalwire.com/api/datasphere/documents/id"

payload = { "tags": ["sports", "football", "game"] }
headers = {
    "Authorization": "Basic <project_id>:<api_token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://{your_space_name}.signalwire.com/api/datasphere/documents/id';
const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Basic <project_id>:<api_token>',
    'Content-Type': 'application/json'
  },
  body: '{"tags":["sports","football","game"]}'
};

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://{your_space_name}.signalwire.com/api/datasphere/documents/id"

	payload := strings.NewReader("{\n  \"tags\": [\n    \"sports\",\n    \"football\",\n    \"game\"\n  ]\n}")

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

	req.Header.Add("Authorization", "Basic <project_id>:<api_token>")
	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://{your_space_name}.signalwire.com/api/datasphere/documents/id")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <project_id>:<api_token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tags\": [\n    \"sports\",\n    \"football\",\n    \"game\"\n  ]\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.patch("https://{your_space_name}.signalwire.com/api/datasphere/documents/id")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tags\": [\n    \"sports\",\n    \"football\",\n    \"game\"\n  ]\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://{your_space_name}.signalwire.com/api/datasphere/documents/id', [
  'body' => '{
  "tags": [
    "sports",
    "football",
    "game"
  ]
}',
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://{your_space_name}.signalwire.com/api/datasphere/documents/id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"tags\": [\n    \"sports\",\n    \"football\",\n    \"game\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Basic <project_id>:<api_token>",
  "Content-Type": "application/json"
]
let parameters = ["tags": ["sports", "football", "game"]] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/datasphere/documents/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
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()
```