fimidara REST API

These pages are generated from the public endpoint definitions. Use them as the reference for paths, headers, query parameters, and bodies.

Base URL

Hosted API - https://api.fimidara.com

Self-hosted - use your own origin (for example https://domain.com).

Authentication

Most endpoints accept an optional Authorization: Bearer <jwt> header, where the JWT comes from an agent token. Requests without a token are treated as public and evaluated against the workspace Public permission group.

File reads can also use a presigned path in the URL instead of a bearer token (useful for images and downloads).

Image transforms

GET /v1/files/readFile/... accepts resize and format query params (w, h, fit, format, and more). See the readFile GET docs.Image transformation guide and readFile GET.

Endpoints
  • abortUpload—post
  • completeMultipartUpload—post
  • deleteFile—delete
  • getFileDetails—post
  • listParts—post
  • readFile—get
  • readFile—head
  • readFile—post
  • startMultipartUpload—post
  • updateFileDetails—post
  • uploadFile—post
  • addToken—post
  • countWorkspaceTokens—post
  • deleteToken—delete
  • encodeToken—post
  • getToken—post
  • getWorkspaceTokens—post
  • refreshToken—post
  • updateToken—post
  • addFolder—post
  • countFolderContent—post
  • deleteFolder—delete
  • getFolder—post
  • listFolderContent—post
  • updateFolder—post
  • addPermissionGroup—post
  • assignPermissionGroups—post
  • countWorkspacePermissionGroups—post
  • deletePermissionGroup—delete
  • getEntityAssignedPermissionGroups—post
  • getPermissionGroup—post
  • getWorkspacePermissionGroups—post
  • unassignPermissionGroups—post
  • updatePermissionGroup—post
  • addItems—post
  • deleteItems—delete
  • resolveEntityPermissions—post
  • countWorkspaceRequests—post
  • deleteRequest—delete
  • getWorkspaceRequest—post
  • getWorkspaceRequests—post
  • revokeRequest—post
  • sendRequest—post
  • updateRequest—post
  • countWorkspaceCollaborators—post
  • getCollaborator—post
  • getWorkspaceCollaborators—post
  • removeCollaborator—post
  • countWorkspaceSummedUsage—post
  • getUsageCosts—post
  • getWorkspaceSummedUsage—post
  • getJobStatus—post
  • getPresignedPaths—post
  • issuePresignedPath—post
  • getResources—post
  • getWorkspace—post
  • updateWorkspace—post