Update a file in a space

Server URLloading...

PATCH

/v1/spaces/{spaceId}/files/{fileId}

Send

Authorization

Path

Header

Body

Updates the editable fields of a file within a space.

You must provide the space ID and file ID in the path and the user ID, tenant ID in the headers.

Behavior:

• This is a partial update — only the fields present in the payload are changed; any omitted field is left unchanged.
• At least one field must be provided.
• Send null for a field to clear its stored value.

Editable fields:

• summary — a short summary of the document content.
• documentKind — the kind or type of document.

Access Control:

Access to update files in a space depends on your permissions and the space's visibility:

• Private Spaces: Only accessible by the space owner
• Public Spaces: Accessible by all users within the same tenant

Path Parameters

Header Parameters

The file fields to update

Response Body

curl -X PATCH "https://example.com/v1/spaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "x-user-id: string" \  -H "x-tenant-id: string" \  -H "Content-Type: application/json" \  -d '{    "summary": "Quarterly financial overview for Q3 2025.",    "documentKind": "Report"  }'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "originalName": "document.pdf",
  "summary": "Quarterly financial overview",
  "language": "en",
  "documentKind": "Report",
  "domain": "Finance",
  "chunksCount": 12,
  "charactersCount": 15240,
  "tags": [
    {
      "key": "author",
      "value": "Jane Doe",
      "aiExtracted": true
    }
  ]
}

{
  "message": "x-user-id is required"
}

{
  "message": "Invalid API Key"
}

{
  "message": "API Key does not have permission to access this resource"
}

{
  "message": "Space not found"
}

{
  "message": "Internal Server Error"
}