lamin-api-client

Lamin API

• API version: 0.1.0
  • Build date: 2026-01-19T09:11:02.411898486+01:00[Europe/Brussels]
  • Generator version: 7.12.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy -P deployment

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>ai.lamin</groupId>
  <artifactId>lamin-api-client</artifactId>
  <version>0.0.5</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'lamin-api-client' jar has been published to maven central.
    mavenLocal()       // Needed if the 'lamin-api-client' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "ai.lamin:lamin-api-client:0.0.5"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/lamin-api-client-0.0.5.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import ai.lamin.lamin_api_client.ApiClient;
import ai.lamin.lamin_api_client.ApiException;
import ai.lamin.lamin_api_client.Configuration;
import ai.lamin.lamin_api_client.model.*;
import ai.lamin.lamin_api_client.api.AccountsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://staging.laminhub.com/api");

    AccountsApi apiInstance = new AccountsApi(defaultClient);
    String authorization = "authorization_example"; // String | 
    try {
      Object result = apiInstance.getCallerAccountAccountGet(authorization);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountsApi#getCallerAccountAccountGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to https://staging.laminhub.com/api

Class	Method	HTTP request	Description
AccountsApi	getCallerAccountAccountGet	GET /account	Get Caller Account
BackwardCompatibleEndpointsApi	getDbTokenBackwardCompatibleAccessV2InstancesInstanceIdDbTokenGet	GET /access_v2/instances/{instance_id}/db_token	Get Db Token Backward Compatible
CacheApi	getInstanceCacheCacheInstancesInstanceIdGet	GET /cache/instances/{instance_id}	Get Instance Cache
CacheApi	invalidateInstanceCacheCacheInstancesInstanceIdDelete	DELETE /cache/instances/{instance_id}	Invalidate Instance Cache
DbServerApi	checkDbServerAccessDbServerCheckAccessPost	POST /db/server/check-access	Check Db Server Access
DbServerApi	registerDbServerDbServerRegisterPost	POST /db/server/register	Register Db Server
HealthChecksApi	healthCheckHealthGet	GET /health	Health Check
InstanceArtifactsApi	createArtifactInstancesInstanceIdArtifactsCreatePost	POST /instances/{instance_id}/artifacts/create	Create Artifact
InstanceArtifactsApi	getArtifactByPathInstancesInstanceIdArtifactsByPathGet	GET /instances/{instance_id}/artifacts/by-path	Get Artifact By Path
InstanceArtifactsApi	uploadArtifactInstancesInstanceIdArtifactsUploadPost	POST /instances/{instance_id}/artifacts/upload	Upload Artifact
InstanceDbTokenApi	getDbTokenInstancesInstanceIdDbTokenGet	GET /instances/{instance_id}/db_token	Get Db Token
InstanceFeaturesApi	queryLinkedFeaturesInstancesInstanceIdModulesModuleNameModelNameQueryFeaturesPost	POST /instances/{instance_id}/modules/{module_name}/{model_name}/query_features	Query Linked Features
InstanceFileExplorerApi	getTreeInstancesInstanceIdFilesTreeGet	GET /instances/{instance_id}/files/tree	Get Tree
InstanceFileExplorerApi	listDirectoryInstancesInstanceIdFilesEntityTypeGet	GET /instances/{instance_id}/files/{entity_type}	List Directory
InstanceFormsApi	registerFormInstancesInstanceIdFormsPost	POST /instances/{instance_id}/forms	Register Form
InstanceFunctionsApi	executeFunctionInstancesInstanceIdFunctionExecutePost	POST /instances/{instance_id}/function/execute	Execute Function
InstanceLabelsApi	attachLabelInstancesInstanceIdModulesModuleNameModelNameIdLabelFieldLabelIdPut	PUT /instances/{instance_id}/modules/{module_name}/{model_name}/{id}/{label_field}/{label_id}	Attach Label
InstanceLabelsApi	detachLabelInstancesInstanceIdModulesModuleNameModelNameIdLabelFieldLabelIdDelete	DELETE /instances/{instance_id}/modules/{module_name}/{model_name}/{id}/{label_field}/{label_id}	Detach Label
InstanceRecordsApi	batchDeleteRecordsInstancesInstanceIdModulesModuleNameModelNameBatchDeletePost	POST /instances/{instance_id}/modules/{module_name}/{model_name}/batch-delete	Batch Delete Records
InstanceRecordsApi	batchSyncLinksInstancesInstanceIdModulesModuleNameModelNameBatchSyncLinksPut	PUT /instances/{instance_id}/modules/{module_name}/{model_name}/batch-sync-links	Synchronize sets of links for multiple scopes in a single call
InstanceRecordsApi	batchUpdateRecordsInstancesInstanceIdModulesModuleNameModelNameBatchUpdatePatch	PATCH /instances/{instance_id}/modules/{module_name}/{model_name}/batch-update	Update one or more records in a batch
InstanceRecordsApi	createRecordsInstancesInstanceIdModulesModuleNameModelNamePut	PUT /instances/{instance_id}/modules/{module_name}/{model_name}	Create Records
InstanceRecordsApi	deleteRecordInstancesInstanceIdModulesModuleNameModelNameUidDelete	DELETE /instances/{instance_id}/modules/{module_name}/{model_name}/{uid}	Delete Record
InstanceRecordsApi	exportRecordsInstancesInstanceIdRecordsUidExportPost	POST /instances/{instance_id}/records/{uid}/export	Export Records
InstanceRecordsApi	getRecordInstancesInstanceIdModulesModuleNameModelNameIdOrUidPost	POST /instances/{instance_id}/modules/{module_name}/{model_name}/{id_or_uid}	Get Record
InstanceRecordsApi	getRecordsInstancesInstanceIdModulesModuleNameModelNamePost	POST /instances/{instance_id}/modules/{module_name}/{model_name}	Get Records
InstanceRecordsApi	getRelativesInstancesInstanceIdModulesModuleNameModelNameRelativesPost	POST /instances/{instance_id}/modules/{module_name}/{model_name}/relatives	Get and query hierarchical relatives of records
InstanceRecordsApi	getValuesInstancesInstanceIdModulesModuleNameModelNameFieldsFieldPathPost	POST /instances/{instance_id}/modules/{module_name}/{model_name}/fields/{field_path}	Get Values
InstanceRecordsApi	updateRecordInstancesInstanceIdModulesModuleNameModelNameUidPatch	PATCH /instances/{instance_id}/modules/{module_name}/{model_name}/{uid}	Update Record
InstanceRecordsApi	upsertRecordsInstancesInstanceIdModulesModuleNameModelNameUpsertPut	PUT /instances/{instance_id}/modules/{module_name}/{model_name}/upsert	Upsert one or more records
InstanceSchemaApi	getRelationsInstancesInstanceIdSchemaModuleNameModelNameGet	GET /instances/{instance_id}/schema/{module_name}/{model_name}	Get Relations
InstanceSchemaApi	getSchemaInstancesInstanceIdSchemaGet	GET /instances/{instance_id}/schema	Get Schema
InstanceSearchApi	globalSearchInstancesInstanceIdSearchGet	GET /instances/{instance_id}/search	Global Search
InstanceStatisticsApi	getInstanceStatisticsInstancesInstanceIdStatisticsGet	GET /instances/{instance_id}/statistics	Get Approximate Table Row Counts and Artifact Size
InstanceStatisticsApi	getNonEmptyTablesInstancesInstanceIdNonEmptyTablesGet	GET /instances/{instance_id}/non_empty_tables	List Non-Empty Data Tables by Module
InstanceStatisticsApi	getRelationCountsInstancesInstanceIdModulesModuleNameModelNameIdCountsGet	GET /instances/{instance_id}/modules/{module_name}/{model_name}/{id}/counts	Get Relation Counts
InstanceStatisticsApi	groupByInstancesInstanceIdModulesModuleNameModelNameGroupByPost	POST /instances/{instance_id}/modules/{module_name}/{model_name}/group-by	Group By
InstanceTransformsApi	createTransformInstancesInstanceIdTransformsPost	POST /instances/{instance_id}/transforms	Create Transform
InstancesApi	addCollaboratorInstancesInstanceIdCollaboratorsPut	PUT /instances/{instance_id}/collaborators	Add Collaborator
InstancesApi	createInstanceInstancesPut	PUT /instances	Create Instance
InstancesApi	deleteInstanceInstancesInstanceIdDelete	DELETE /instances/{instance_id}	Delete Instance
InstancesApi	listCollaboratorsInstancesInstanceIdCollaboratorsGet	GET /instances/{instance_id}/collaborators	List Collaborators
InstancesApi	migrateInstanceInstancesInstanceIdMigratePost	POST /instances/{instance_id}/migrate	Migrate Instance
InstancesApi	removeCollaboratorInstancesInstanceIdCollaboratorsDelete	DELETE /instances/{instance_id}/collaborators	Remove Collaborator
InstancesApi	transferOwnershipInstancesInstanceIdOwnerHandlePatch	PATCH /instances/{instance_id}/owner/{handle}	Transfer Ownership
InstancesApi	updateCollaboratorInstancesInstanceIdCollaboratorsPatch	PATCH /instances/{instance_id}/collaborators	Update Collaborator
OrganizationsApi	addOrganizationMemberOrganizationsOrganizationIdMembersAccountIdPut	PUT /organizations/{organization_id}/members/{account_id}	Add Organization Member
OrganizationsApi	getOrganizationOrganizationsOrganizationIdGet	GET /organizations/{organization_id}	Get Organization
OrganizationsApi	listOrganizationMembersOrganizationsOrganizationIdMembersGet	GET /organizations/{organization_id}/members	List Organization Members
OrganizationsApi	removeOrganizationMemberOrganizationsOrganizationIdMembersAccountIdDelete	DELETE /organizations/{organization_id}/members/{account_id}	Remove Organization Member
OrganizationsApi	updateOrganizationMemberOrganizationsOrganizationIdMembersAccountIdPatch	PATCH /organizations/{organization_id}/members/{account_id}	Update Organization Member
SpacesApi	addSpaceCollaboratorSpacesSpaceIdCollaboratorsPut	PUT /spaces/{space_id}/collaborators	Add Space Collaborator
SpacesApi	attachSpaceToInstanceSpacesSpaceIdInstancesInstanceIdPut	PUT /spaces/{space_id}/instances/{instance_id}	Attach Space To Instance
SpacesApi	createSpaceSpacesPut	PUT /spaces	Create Space
SpacesApi	deleteSpaceSpacesSpaceIdDelete	DELETE /spaces/{space_id}	Delete Space
SpacesApi	detachSpaceFromInstanceSpacesSpaceIdInstancesInstanceIdDelete	DELETE /spaces/{space_id}/instances/{instance_id}	Detach Space From Instance
SpacesApi	getSpaceSpacesSpaceIdGet	GET /spaces/{space_id}	Get Space
SpacesApi	listInstanceSpacesSpacesInstancesInstanceIdGet	GET /spaces/instances/{instance_id}	List Instance Spaces
SpacesApi	listInstancesUsingSpaceSpacesSpaceIdInstancesGet	GET /spaces/{space_id}/instances	List Instances Using Space
SpacesApi	listOrganizationSpacesSpacesOrganizationsOrganizationIdGet	GET /spaces/organizations/{organization_id}	List Organization Spaces
SpacesApi	listSpaceCollaboratorsSpacesSpaceIdCollaboratorsGet	GET /spaces/{space_id}/collaborators	List Space Collaborators
SpacesApi	moveRecordToSpaceSpacesSpaceIdRecordAttachmentsPut	PUT /spaces/{space_id}/record-attachments	Move Record To Space
SpacesApi	removeSpaceCollaboratorSpacesSpaceIdCollaboratorsDelete	DELETE /spaces/{space_id}/collaborators	Remove Space Collaborator
SpacesApi	updateSpaceCollaboratorSpacesSpaceIdCollaboratorsPatch	PATCH /spaces/{space_id}/collaborators	Update Space Collaborator
SpacesApi	updateSpaceSpacesSpaceIdPatch	PATCH /spaces/{space_id}	Update Space
StoragesApi	grantS3PermissionsStoragesS3BucketNamePermissionsPut	PUT /storages/s3/{bucket_name}/permissions	Grant S3 Permissions
TeamsApi	addTeamMemberTeamsTeamIdMembersAccountIdPut	PUT /teams/{team_id}/members/{account_id}	Add Team Member
TeamsApi	createTeamTeamsPut	PUT /teams	Create Team
TeamsApi	deleteTeamTeamsTeamIdDelete	DELETE /teams/{team_id}	Delete Team
TeamsApi	getTeamTeamsTeamIdGet	GET /teams/{team_id}	Get Team
TeamsApi	listOrganizationTeamsTeamsOrganizationsOrganizationIdGet	GET /teams/organizations/{organization_id}	List Organization Teams
TeamsApi	listTeamMembersTeamsTeamIdMembersGet	GET /teams/{team_id}/members	List Team Members
TeamsApi	removeTeamMemberTeamsTeamIdMembersAccountIdDelete	DELETE /teams/{team_id}/members/{account_id}	Remove Team Member
TeamsApi	updateTeamMemberTeamsTeamIdMembersAccountIdPatch	PATCH /teams/{team_id}/members/{account_id}	Update Team Member
TeamsApi	updateTeamTeamsTeamIdPatch	PATCH /teams/{team_id}	Update Team

Documentation for Models

• AddCollaboratorRequestBody
• AddOrganizationMemberRequestBody
• AddSpaceCollaboratorRequestBody
• AddTeamMemberRequestBody
• AttachSpaceToRecordRequestBody
• BatchDeleteBody
• BatchDeleteResponse
• BatchSyncLinksBody
• BatchSyncResponse
• BatchUpdateBody
• Body
• CreateArtifactRequestBody
• CreateSpaceRequestBody
• CreateTeamRequestBody
• CreateTransformRequestBody
• Dimension
• ErrorDetail
• ExecuteFunctionRequestBody
• ExportRecordsRequestBody
• GetRecordRequestBody
• GetRecordsRequestBody
• GetValuesRequestBody
• GroupByRequestBody
• HTTPValidationError
• Measure
• NonEmptyTablesResponse
• OrderByColumn
• RegisterDbServerBody
• RegisterFormRequest
• Request
• Role
• Role1
• S3PermissionsRequest
• StatisticsResponse
• SyncInstruction
• TraversalParams
• TraversalParamsValuesInner
• UpdateCollaboratorRequestBody
• UpdateOrganizationMemberRequestBody
• UpdateSpaceCollaboratorRequestBody
• UpdateSpaceRequestBody
• UpdateTeamMemberRequestBody
• UpdateTeamRequestBody
• ValidationError
• ValidationErrorLocInner

Documentation for Authorization

Endpoints do not require authorization.

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author