Skip to main content
PATCH
/
context-documents
/
tree
/
{tree_id}
/
files
Edit files in a draft tree before publishing
curl --request PATCH \
  --url https://api.hyperspell.com/context-documents/tree/{tree_id}/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "files": {}
}'
{
  "tree_id": "<string>",
  "status": "<string>",
  "version": 123,
  "files": [
    {
      "path": "<string>",
      "content": "<string>",
      "tier": "<string>",
      "team": "<string>",
      "updated_at": "<string>"
    }
  ],
  "error": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "meta": {}
}

Authorizations

Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Path Parameters

tree_id
string
required

Body

application/json

Request body for editing files before publishing.

files
Files · object
required

Map of file path → new content. Only provided paths are updated.

Response

Successful Response

tree_id
string
required
status
string
required
version
integer
required
files
TreeFile · object[] | null
required
error
string | null
required
created_at
string<date-time>
required
completed_at
string<date-time> | null
required
meta
Meta · object
required