List or read files

const options = {method: 'GET', headers: {cookie: 'overlay_session='}};

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: 'GET', headers: {cookie: 'overlay_session='}};

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

curl --request GET \
  --url https://getoverlay.io/api/v1/files \
  --cookie overlay_session=

"<unknown>"

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

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

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

GET

api

files

List or read files

const options = {method: 'GET', headers: {cookie: 'overlay_session='}};

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: 'GET', headers: {cookie: 'overlay_session='}};

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

curl --request GET \
  --url https://getoverlay.io/api/v1/files \
  --cookie overlay_session=

"<unknown>"

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

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

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

Authorizations

overlay_session

string

required

Signed httpOnly browser session cookie.

Query Parameters

cursor

string

limit

integer

default:20

Required range: 1 <= x <= 100

sort

enum<string>

default:updatedAt

Available options:

createdAt,

updatedAt,

name

order

enum<string>

default:desc

Available options:

asc,

desc

fileId

string

Minimum string length: 1

projectId

string

Minimum string length: 1

kind

string

parentId

string

Minimum string length: 1

conversationId

string

Minimum string length: 1

outputType

string

type

string

summary

enum<string>

Available options:

true,

false,

1,

0

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.

Create a stream auth token Create a file