Update a file

const options = {
  method: 'PATCH',
  headers: {cookie: 'overlay_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({fileId: '<string>'})
};

fetch('https://getoverlay.io/api/v1/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'PATCH',
  headers: {cookie: 'overlay_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({fileId: '<string>'})
};

fetch('https://getoverlay.io/api/v1/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request PATCH \
  --url https://getoverlay.io/api/v1/files \
  --header 'Content-Type: application/json' \
  --cookie overlay_session= \
  --data '
{
  "fileId": "<string>"
}
'

"<unknown>"

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

PATCH

api

files

Update a file

const options = {
  method: 'PATCH',
  headers: {cookie: 'overlay_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({fileId: '<string>'})
};

fetch('https://getoverlay.io/api/v1/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'PATCH',
  headers: {cookie: 'overlay_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({fileId: '<string>'})
};

fetch('https://getoverlay.io/api/v1/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request PATCH \
  --url https://getoverlay.io/api/v1/files \
  --header 'Content-Type: application/json' \
  --cookie overlay_session= \
  --data '
{
  "fileId": "<string>"
}
'

"<unknown>"

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Authorizations

overlay_session

string

required

Signed httpOnly browser session cookie.

Body

application/json

fileId

string

required

Minimum string length: 1

accessToken

string

Minimum string length: 1

userId

string

Minimum string length: 1

name

string

Minimum string length: 1

mimeType

string

sizeBytes

number

Required range: x >= 0

projectId

string | null

parentId

string | null

conversationId

string

kind

string

Response

Successful response. Stable response schemas are documented in workflow guides when available.

Response shape is route-specific and may be backed by @overlay/app-core contracts.

Delete a file Download file content