Lucidtech API
The Lucidtech API provides a comprehensive REST interface for managing the full AI/ML lifecycle—organizations, assets, datasets, models, trainings, predictions, workflows, and related resources such as users, secrets, and payment methods—allowing clients to create, retrieve, update, and delete these entities and orchestrate workflow executions.
Admin: update documentationPOST
/organizations
Content-Type ( header , required ) GET
/organizations/{organizationId}
organizationId ( path , required ) OPTIONS
/organizations/{organizationId}
organizationId ( path , required ) PATCH
/organizations/{organizationId}
Content-Type ( header , required ) organizationId ( path , required ) GET
/paymentMethods
nextToken ( query ) maxResults ( query , limit ) POST
/paymentMethods
Content-Type ( header , required ) DELETE
/paymentMethods/{paymentMethodId}
paymentMethodId ( path , required ) GET
/paymentMethods/{paymentMethodId}
paymentMethodId ( path , required ) OPTIONS
/paymentMethods/{paymentMethodId}
paymentMethodId ( path , required ) POST
/appClients
Content-Type ( header , required ) DELETE
/appClients/{appClientId}
appClientId ( path , required ) OPTIONS
/appClients/{appClientId}
appClientId ( path , required ) PATCH
/appClients/{appClientId}
appClientId ( path , required ) Content-Type ( header , required ) GET
/assets
nextToken ( query ) maxResults ( query , limit ) POST
/assets
Content-Type ( header , required ) PATCH
/assets/{assetId}
Content-Type ( header , required ) assetId ( path , required ) GET
/datasets
nextToken ( query ) maxResults ( query , limit ) POST
/datasets
Content-Type ( header , required ) DELETE
/datasets/{datasetId}
datasetId ( path , required ) GET
/datasets/{datasetId}
datasetId ( path , required ) OPTIONS
/datasets/{datasetId}
datasetId ( path , required ) PATCH
/datasets/{datasetId}
Content-Type ( header , required ) datasetId ( path , required ) GET
/deploymentEnvironments
owner ( query ) nextToken ( query ) maxResults ( query , limit ) GET
/deploymentEnvironments/{deploymentEnvironmentId}
deploymentEnvironmentId ( path , required ) OPTIONS
/deploymentEnvironments/{deploymentEnvironmentId}
deploymentEnvironmentId ( path , required ) PATCH
/paymentMethods/{paymentMethodId}
Content-Type ( header , required ) paymentMethodId ( path , required ) PATCH
/models/{modelId}/trainings/{trainingId}
Content-Type ( header , required ) modelId ( path , required ) trainingId ( path , required ) DELETE
/documents
consentId ( query ) datasetId ( query ) nextToken ( query ) maxResults ( query , limit ) OPTIONS
/models/{modelId}/trainings/{trainingId}
modelId ( path , required ) trainingId ( path , required ) GET
/organizations
nextToken ( query ) maxResults ( query , limit ) GET
/appClients
nextToken ( query ) maxResults ( query , limit ) GET
/documents
datasetId ( query ) nextToken ( query ) order ( query ) documentId ( query ) consentId ( query ) maxResults ( query , limit ) sortBy ( query ) POST
/documents
Content-Type ( header , required ) DELETE
/documents/{documentId}
documentId ( path , required ) GET
/documents/{documentId}
documentId ( path , required ) OPTIONS
/documents/{documentId}
documentId ( path , required ) PATCH
/documents/{documentId}
Content-Type ( header , required ) documentId ( path , required ) GET
/logs
workflowId ( query ) nextToken ( query ) order ( query ) transitionExecutionId ( query ) transitionId ( query ) maxResults ( query , limit ) workflowExecutionId ( query ) GET
/models
owner ( query ) nextToken ( query ) maxResults ( query , limit ) POST
/models
Content-Type ( header , required ) PATCH
/models/{modelId}
Content-Type ( header , required ) modelId ( path , required ) GET
/models/{modelId}/dataBundles
modelId ( path , required ) status ( query ) nextToken ( query ) maxResults ( query , limit ) OPTIONS
/models/{modelId}/dataBundles
POST
/models/{modelId}/dataBundles
Content-Type ( header , required ) modelId ( path , required ) DELETE
/models/{modelId}/dataBundles/{dataBundleId}
dataBundleId ( path , required ) modelId ( path , required ) OPTIONS
/models/{modelId}/dataBundles/{dataBundleId}
dataBundleId ( path , required ) modelId ( path , required ) PATCH
/models/{modelId}/dataBundles/{dataBundleId}
dataBundleId ( path , required ) Content-Type ( header , required ) modelId ( path , required ) GET
/models/{modelId}/trainings
modelId ( path , required ) status ( query ) nextToken ( query ) maxResults ( query , limit ) OPTIONS
/models/{modelId}/trainings
POST
/models/{modelId}/trainings
Content-Type ( header , required ) modelId ( path , required ) GET
/plans
owner ( query ) nextToken ( query ) maxResults ( query , limit ) GET
/predictions
nextToken ( query ) maxResults ( query , limit ) sortBy ( query ) order ( query ) POST
/predictions
Content-Type ( header , required ) GET
/profiles/{profileId}
profileId ( path , required ) OPTIONS
/profiles/{profileId}
profileId ( path , required ) PATCH
/profiles/{profileId}
profileId ( path , required ) GET
/secrets
nextToken ( query ) maxResults ( query , limit ) POST
/secrets
Content-Type ( header , required ) DELETE
/secrets/{secretId}
secretId ( path , required ) OPTIONS
/secrets/{secretId}
secretId ( path , required ) PATCH
/secrets/{secretId}
Content-Type ( header , required ) secretId ( path , required ) POST
/signup
Content-Type ( header , required ) GET
/transitions
transitionType ( query ) nextToken ( query ) maxResults ( query , limit ) POST
/transitions
Content-Type ( header , required ) DELETE
/transitions/{transitionId}
transitionId ( path , required ) GET
/transitions/{transitionId}
transitionId ( path , required ) OPTIONS
/transitions/{transitionId}
transitionId ( path , required ) PATCH
/transitions/{transitionId}
Content-Type ( header , required ) transitionId ( path , required ) GET
/transitions/{transitionId}/executions
nextToken ( query ) order ( query ) executionId ( query ) transitionId ( path , required ) status ( query ) maxResults ( query , limit ) sortBy ( query ) OPTIONS
/transitions/{transitionId}/executions
transitionId ( path , required ) POST
/transitions/{transitionId}/executions
Content-Type ( header , required ) transitionId ( path , required ) GET
/transitions/{transitionId}/executions/{executionId}
transitionId ( path , required ) executionId ( path , required ) OPTIONS
/transitions/{transitionId}/executions/{executionId}
transitionId ( path , required ) executionId ( path , required ) PATCH
/transitions/{transitionId}/executions/{executionId}
Content-Type ( header , required ) transitionId ( path , required ) executionId ( path , required ) OPTIONS
/transitions/{transitionId}/executions/{executionId}/heartbeats
transitionId ( path , required ) executionId ( path , required ) POST
/transitions/{transitionId}/executions/{executionId}/heartbeats
Content-Type ( header , required ) transitionId ( path , required ) executionId ( path , required ) GET
/users
nextToken ( query ) maxResults ( query , limit ) POST
/users
Content-Type ( header , required ) PATCH
/users/{userId}
Content-Type ( header , required ) userId ( path , required ) GET
/workflows
nextToken ( query ) maxResults ( query , limit ) POST
/workflows
Content-Type ( header , required ) DELETE
/workflows/{workflowId}
workflowId ( path , required ) GET
/workflows/{workflowId}
workflowId ( path , required ) OPTIONS
/workflows/{workflowId}
workflowId ( path , required ) PATCH
/workflows/{workflowId}
Content-Type ( header , required ) workflowId ( path , required ) GET
/workflows/{workflowId}/executions
fromStartTime ( query ) toStartTime ( query ) workflowId ( path , required ) nextToken ( query ) order ( query ) status ( query ) maxResults ( query , limit ) sortBy ( query ) OPTIONS
/workflows/{workflowId}/executions
workflowId ( path , required ) POST
/workflows/{workflowId}/executions
Content-Type ( header , required ) workflowId ( path , required ) DELETE
/workflows/{workflowId}/executions/{executionId}
executionId ( path , required ) workflowId ( path , required ) GET
/workflows/{workflowId}/executions/{executionId}
executionId ( path , required ) workflowId ( path , required ) OPTIONS
/workflows/{workflowId}/executions/{executionId}
executionId ( path , required ) workflowId ( path , required ) PATCH
/workflows/{workflowId}/executions/{executionId}
Content-Type ( header , required ) executionId ( path , required ) workflowId ( path , required )
121 endpoints auto-detected
Authentication
This API requires authentication: OAuth.
curl -X OPTIONS \
"https://api.lucidtech.ai/{basePath}/organizations" api.lucidtech.ai · HTTPS only