/v1/fileBackends/addConfig
—
post
Path Parameters
Request Headers
HttpEndpointRequestHeaders_AuthRequired_JsonContentType

FieldTypeRequiredDescription
AuthorizationstringYes

Access token

Example: Bearer <token>

Content-TypestringYes

HTTP JSON request content type

Example: application/json

Request Query
Request Body
AddFileBackendConfigEndpointParams

Parameters for creating a new file backend config to store credentials and settings for external storage providers

{
workspaceId?: string
name: string
description?: string
backend: string
credentials: FileBackendConfigCredentials
}
FileBackendConfigCredentials

Authentication credentials and configuration for the backend provider. Structure varies by backend type: - AWS S3: accessKeyId, secretAccessKey, region, etc. - Google Cloud: service account key JSON - Azure: connection string or account keys Store sensitive values as environment variable references.

{}
200 — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

Example: 1024

200 — Response Body
AddFileBackendConfigEndpointResult

Response when successfully creating a new file backend config

{
config: FileBackendConfig
}
FileBackendConfig

A file backend config stores credentials and settings for connecting to external storage providers like AWS S3, Google Cloud Storage, etc.

{
resourceId: string
createdBy: Agent
createdAt: number
lastUpdatedBy: Agent
lastUpdatedAt: number
isDeleted: boolean
deletedAt?: number
deletedBy?: Agent
workspaceId: string
name: string
description?: string
backend: string
}
Agent

Represents a user or system entity that performed an action (e.g., created or updated a resource)

{
agentId: string
agentType: string
}
4XX or 5XX — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

4XX or 5XX — Response Body
EndpointErrorResult

Endpoint error result

{
errors?: Array<ExternalError>
}
ExternalError

{
message: string
}