Passer au contenu principal
PATCH
/
documents
/
{document_id}
/
access
/
metadata
Mettre à jour les métadonnées d'accès au document
import requests

url = "https://app.ubik-agent.com/api/v1/documents/{document_id}/access/metadata"

payload = {
    "api_metadata": {},
    "external_user_id": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Autorisations

​
X-API-KEY
string
header
requis

En-têtes

​
X-End-User-ID
string | null

Paramètres de chemin

​
document_id
string<uuid>
requis

Corps

application/json
​
api_metadata
Api Metadata · object
requis

Métadonnées JSON personnalisées. Utile pour stocker des références de systèmes externes (par exemple, {'internal_app_ref': 'REF-123'}). Ces métadonnées sont limitées : les mises à jour ici s'appliquent uniquement à l'external_user_id spécifié (ou globalement si omis). Lors de la récupération, les métadonnées spécifiques à l'utilisateur remplacent les métadonnées globales.

​
external_user_id
string | null

L'ID utilisateur externe à mettre à jour. Si omis, met à jour la règle d'accès globale. Note : Si le document a été téléversé/limité à un utilisateur spécifique, vous devez fournir cet ID ici pour mettre à jour ses métadonnées spécifiques.

Réponse

Successful Response