Skip to main content
POST
/
api
/
workers
/
{workerId}
/
resources
/
link
Create a new link resource
curl --request POST \
  --url https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/resources/link \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "rawLink": "<string>",
  "updateFrequency": "<string>",
  "folderId": "<string>"
}
'
{
  "id": "<string>",
  "ragType": "FILE",
  "lastUpdated": "2023-11-07T05:31:56Z",
  "updateFrequency": "<string>",
  "rawLink": "<string>",
  "key": "<string>",
  "s3FilePath": "<string>",
  "imageS3FilePath": "<string>",
  "signedS3FilePath": "<string>",
  "numScrolls": 123,
  "fileName": "<string>",
  "mimeType": "<string>",
  "status": "STARTED",
  "processingError": "<string>",
  "graphStatus": {},
  "size": 123,
  "uploadedAt": "2023-11-07T05:31:56Z",
  "folderId": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key authentication

Path Parameters

​
workerId
string
required

Body

application/json
​
name
string
required
​
rawLink
string
required
​
updateFrequency
string
required
​
folderId
string

Response

Link resource created

​
id
string
required
​
ragType
enum<string>
required
Available options:
FILE,
WEBPAGE,
SITEMAP
​
lastUpdated
string<date-time> | null
​
updateFrequency
string | null
​
rawLink
string | null
​
key
string | null
​
s3FilePath
string | null
​
imageS3FilePath
string | null
​
signedS3FilePath
string | null
​
numScrolls
integer | null
​
fileName
string | null
​
mimeType
string | null
​
status
enum<string>
Available options:
STARTED,
PROCESSING,
FAILED,
AVAILABLE,
DELETED
​
processingError
string | null
​
graphStatus
object
​
size
integer | null
​
uploadedAt
string<date-time> | null
​
folderId
string | null