Lucid

Lucid Cloud API

Manage cloud infrastructure credentials, data sources, and architecture diagrams for AWS, Azure, and Google Cloud.

GitHub OpenAPI

Operations 50

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/credentials/aws/externalId Get the AWS external ID for a trust relationship · Get AWS External ID #
Ask an LLM
“What external ID do I put in my AWS IAM role trust policy so Lucid Cloud can assume it?”
“Where do I find the AWS external ID I need before creating an AWS credential?”
Tell an agent
Fetch my AWS external ID for setting up the IAM trust relationship.
Give me the external ID to paste into my AWS role's trust policy.
POST /v1/credentials/aws Add an AWS credential to Lucid Cloud · Create AWS Credential #
Ask an LLM
“How do I connect my AWS account to Lucid Cloud using an IAM role ARN?”
“Can I add an AWS credential that uses an organization member account role name?”
Tell an agent
Create an AWS credential named {name} using role ARN {arn}.
Add AWS credential {name} for role {arn} with member account role {orgMemberAccountRoleName}.
PATCH /v1/credentials/aws/{awsCredentialId} Update an existing AWS credential · Update AWS Credential #
Ask an LLM
“Can I change the role ARN on an AWS credential I already saved in Lucid Cloud?”
“Is it possible to rename an existing AWS credential?”
Tell an agent
Change the role ARN on AWS credential {awsCredentialId} to {arn}.
Rename AWS credential {awsCredentialId} to {name}.
POST /v1/credentials/azure Add an Azure credential to Lucid Cloud · Create Azure Credential #
Ask an LLM
“How do I connect an Azure tenant to Lucid Cloud with a service principal client ID and secret?”
“What details does Lucid need to create an Azure credential?”
Tell an agent
Create Azure credential {name} with client ID {clientId}, tenant {tenantId} and secret {clientSecret}.
Add a new Azure credential for tenant {tenantId} using app {clientId} and secret {clientSecret}, called {name}.
PATCH /v1/credentials/azure/{azureCredentialId} Update an existing Azure credential · Update Azure Credential #
Ask an LLM
“Can I rotate the client secret on an Azure credential already saved in Lucid Cloud?”
“Is there a way to change the tenant or client ID on a saved Azure credential?”
Tell an agent
Replace the client secret on Azure credential {azureCredentialId} with {clientSecret}.
Rename Azure credential {azureCredentialId} to {name}.
POST /v1/credentials/googleCloud Add a Google Cloud credential to Lucid Cloud · Create Google Cloud Credential #
Ask an LLM
“How do I connect Google Cloud to Lucid using a service account key file?”
“Can I give my new Google Cloud credential a display name?”
Tell an agent
Create a Google Cloud credential from service account key file {service-account-key-file}.
Add Google Cloud credential {displayName} using key file {service-account-key-file}.
PATCH /v1/credentials/googleCloud/{googleCloudCredentialId} Update an existing Google Cloud credential · Update Google Cloud Credential #
Ask an LLM
“Can I upload a new service account key for a Google Cloud credential I already created?”
“Is it possible to change the display name of a saved Google Cloud credential?”
Tell an agent
Swap the service account key on Google Cloud credential {googleCloudCredentialId} for {service-account-key-file}.
Rename Google Cloud credential {googleCloudCredentialId} to {displayName}.
GET /v1/credentials List all cloud credentials on the account · List Credentials #
Ask an LLM
“Which cloud credentials are saved on my Lucid account?”
“Can I see every AWS, Azure and Google Cloud credential connected to Lucid Cloud at once?”
Tell an agent
List all cloud credentials on my Lucid account.
Show me every connected cloud credential.
GET /v1/credentials/{credentialId} Get details of one cloud credential · Get Credential #
Ask an LLM
“What are the details of a specific cloud credential in Lucid Cloud?”
“Can I look up a single saved credential by its ID?”
Tell an agent
Show the details of credential {credentialId}.
Look up cloud credential {credentialId}.
DELETE /v1/credentials/{credentialId} Delete a cloud credential · Delete Credential #
Ask an LLM
“How do I remove a cloud credential I no longer use from Lucid Cloud?”
“Can I disconnect a saved AWS, Azure or Google Cloud credential?”
Tell an agent destructive · confirm first
Delete credential {credentialId}.
Remove cloud credential {credentialId} from my account.
GET /v1/dataSources/aws/resources List AWS resource types Lucid Cloud supports · Get Fully Supported AWS Resources #
Ask an LLM
“Which AWS resource types does Lucid Cloud fully support?”
“Will Lucid Cloud import my AWS Lambda functions and other services into a data source?”
Tell an agent
List the AWS resources fully supported by Lucid Cloud.
Show which AWS services Lucid Cloud can import.
GET /v2/dataSources/aws/regions List AWS regions Lucid Cloud supports · Get Supported AWS Regions #
Ask an LLM
“Which AWS regions can Lucid Cloud pull data from?”
“Is a particular AWS region supported when creating an AWS data source?”
Tell an agent
List the AWS regions supported by Lucid Cloud.
Show me every AWS region I can include in a data source.
GET /v1/dataSources/azure/resources List Azure resource types Lucid Cloud supports · Get Fully Supported Azure Resources #
Ask an LLM
“Which Azure resource types does Lucid Cloud fully support?”
“Can Lucid Cloud import all the Azure services in my subscription?”
Tell an agent
List the Azure resources fully supported by Lucid Cloud.
Show which Azure services Lucid Cloud can import.
GET /v1/dataSources/googleCloud/resources List Google Cloud resource types Lucid supports · Get Fully Supported Google Cloud Resources #
Ask an LLM
“Which Google Cloud resource types does Lucid Cloud fully support?”
“Will Lucid Cloud import every Google Cloud service in my project?”
Tell an agent
List the Google Cloud resources fully supported by Lucid Cloud.
Show which Google Cloud services Lucid Cloud can import.
POST /v1/dataSources/aws Import AWS account data as a data source · Create AWS Data Source #
Ask an LLM
“How do I import my AWS account's infrastructure into Lucid Cloud?”
“Can I limit an AWS import to certain regions and resource types?”
Tell an agent
Create AWS data source {name} for account {awsAccountId} covering regions {regions}.
Import AWS account {awsAccountId} in {regions} as {name} using credential {awsCredentialId}.
GET /v1/dataSources/aws/{jobReferenceId}/status Check status of an AWS data source import job · Get "Create AWS Data Source" Job Status #
Ask an LLM
“Has my new AWS data source finished importing?”
“What's the progress of the job that's creating my AWS data source?”
Tell an agent
Check the status of AWS data source creation job {jobReferenceId}.
Tell me whether AWS import job {jobReferenceId} is done.
POST /v1/dataSources/aws/{awsDataSourceId} Refresh an AWS data source from live AWS · Update AWS Data Source #
Ask an LLM
“How do I refresh an AWS data source so it reflects my current AWS resources?”
“Can I change the regions included in an AWS data source while re-pulling its data?”
Tell an agent
Refresh AWS data source {awsDataSourceId} with the latest data from AWS.
Re-pull AWS data source {awsDataSourceId} limited to regions {regions}.
PATCH /v1/dataSources/aws/{awsDataSourceId} Rename an AWS data source · Edit AWS Data Source #
Ask an LLM
“Can I rename an AWS data source without re-importing its cloud data?”
“Is there a way to edit just the metadata of an AWS data source?”
Tell an agent
Rename AWS data source {awsDataSourceId} to {name}.
Change the name of my AWS data source {awsDataSourceId} to {name} without syncing data.
POST /v1/dataSources/aws/{awsDataSourceId}/upload Update an AWS data source from an AWS CLI export · Update AWS Data Source from File #
Ask an LLM
“Can I update an AWS data source by uploading a JSON file exported with the AWS CLI?”
“What if Lucid can't reach my AWS account directly — can I upload the data instead?”
Tell an agent
Update AWS data source {awsDataSourceId} from the AWS CLI export {awsclijson}.
Upload AWS CLI JSON {awsclijson} to refresh data source {awsDataSourceId}.
GET /v1/dataSources/aws/{awsDataSourceId}/{jobReferenceId}/status Check status of an AWS data source update job · Get "Update AWS Data Source" Job Status #
Ask an LLM
“Has the refresh of my existing AWS data source completed?”
“What's the status of the AWS CLI file upload I used to update a data source?”
Tell an agent
Check update job {jobReferenceId} for AWS data source {awsDataSourceId}.
Tell me if the refresh {jobReferenceId} of AWS data source {awsDataSourceId} finished.
POST /v1/dataSources/azure Import Azure subscription data as a data source · Create Azure Data Source #
Ask an LLM
“How do I import my Azure subscriptions into Lucid Cloud?”
“Can one Azure data source cover several subscription IDs in a tenant?”
Tell an agent
Create Azure data source {name} for tenant {tenantId}, subscriptions {subscriptionIds}, resources {resourceSelection}.
Import Azure subscriptions {subscriptionIds} in tenant {tenantId} as {name} with resources {resourceSelection} via credential {azureCredentialId}.
GET /v1/dataSources/azure/{jobReferenceId}/status Check status of an Azure data source import job · Get "Create Azure Data Source" Job Status #
Ask an LLM
“Has my new Azure data source finished importing?”
“What's the progress of the job creating my Azure data source?”
Tell an agent
Check the status of Azure data source creation job {jobReferenceId}.
Tell me whether Azure import job {jobReferenceId} is done.
POST /v1/dataSources/azure/{azureDataSourceId} Refresh an Azure data source from live Azure · Update Azure Data Source #
Ask an LLM
“How do I refresh an Azure data source so it matches my current Azure resources?”
“Can I change which Azure resources are included while re-pulling a data source?”
Tell an agent
Refresh Azure data source {azureDataSourceId} with the latest data from Azure.
Re-pull Azure data source {azureDataSourceId} with resource selection {resourceSelection}.
PATCH /v1/dataSources/azure/{azureDataSourceId} Rename an Azure data source · Edit Azure Data Source #
Ask an LLM
“Can I rename an Azure data source without re-importing its data?”
“Is there a way to edit only the metadata of an Azure data source?”
Tell an agent
Rename Azure data source {azureDataSourceId} to {name}.
Change the name of my Azure data source {azureDataSourceId} to {name} without syncing data.
POST /v1/dataSources/azure/{azureDataSourceId}/upload Update an Azure data source from an Azure CLI export · Update Azure Data Source from File #
Ask an LLM
“Can I update an Azure data source by uploading JSON exported with the Azure CLI?”
“If Lucid can't reach my Azure tenant, can I upload the resource data myself?”
Tell an agent
Update Azure data source {azureDataSourceId} from the Azure CLI export {azureclijson}.
Upload Azure CLI JSON {azureclijson} to refresh data source {azureDataSourceId}.
GET /v1/dataSources/azure/{azureDataSourceId}/{jobReferenceId}/status Check status of an Azure data source update job · Get "Update Azure Data Source" Job Status #
Ask an LLM
“Has the refresh of my existing Azure data source completed?”
“After uploading an Azure CLI export to a data source, how can I tell when processing is done?”
Tell an agent
Check update job {jobReferenceId} for Azure data source {azureDataSourceId}.
Tell me if the refresh {jobReferenceId} of Azure data source {azureDataSourceId} finished.
POST /v1/dataSources/googleCloud Import Google Cloud project data as a data source · Create Google Cloud Data Source #
Ask an LLM
“How do I import my Google Cloud projects into Lucid Cloud?”
“Can a single Google Cloud data source span multiple project IDs?”
Tell an agent
Create Google Cloud data source {name} for projects {projectIds} with resources {resourceSelection}.
Import Google Cloud projects {projectIds} as {name}, resources {resourceSelection}, via credential {googleCloudCredentialId}.
GET /v1/dataSources/googleCloud/{jobReferenceId}/status Check status of a Google Cloud data source import · Get "Create Google Cloud Data Source" Job Status #
Ask an LLM
“Has my new Google Cloud data source finished importing?”
“What's the progress of the job creating my Google Cloud data source?”
Tell an agent
Check the status of Google Cloud data source creation job {jobReferenceId}.
Tell me whether Google Cloud import job {jobReferenceId} is done.
POST /v1/dataSources/googleCloud/{googleCloudDataSourceId} Refresh a Google Cloud data source from live data · Update Google Cloud Data Source #
Ask an LLM
“How do I refresh a Google Cloud data source so it matches my current projects?”
“Can I change which Google Cloud resources are included while re-pulling a data source?”
Tell an agent
Refresh Google Cloud data source {googleCloudDataSourceId} with the latest data.
Re-pull Google Cloud data source {googleCloudDataSourceId} with resource selection {resourceSelection}.
PATCH /v1/dataSources/googleCloud/{googleCloudDataSourceId} Rename a Google Cloud data source · Edit Google Cloud Data Source #
Ask an LLM
“Can I rename a Google Cloud data source without re-importing its data?”
“Is there a way to edit only the metadata of a Google Cloud data source?”
Tell an agent
Rename Google Cloud data source {googleCloudDataSourceId} to {name}.
Change the name of Google Cloud data source {googleCloudDataSourceId} to {name} without syncing data.
POST /v1/dataSources/googleCloud/{googleCloudDataSourceId}/upload Update a Google Cloud data source from a CLI export · Update Google Cloud Data Source from File #
Ask an LLM
“Can I update a Google Cloud data source by uploading JSON exported with the Google Cloud CLI?”
“If Lucid can't reach my Google Cloud projects, can I upload the resource data myself?”
Tell an agent
Update Google Cloud data source {googleCloudDataSourceId} from CLI export {googlecloudclijson}.
Upload Google Cloud CLI JSON {googlecloudclijson} to refresh data source {googleCloudDataSourceId}.
GET /v1/dataSources/googleCloud/{googleCloudDataSourceId}/{jobReferenceId}/status Check status of a Google Cloud data source update · Get "Update Google Cloud Data Source" Job Status #
Ask an LLM
“Has the refresh of my existing Google Cloud data source completed?”
“What's the status of the Google Cloud CLI file upload I used to update a data source?”
Tell an agent
Check update job {jobReferenceId} for Google Cloud data source {googleCloudDataSourceId}.
Tell me if refresh {jobReferenceId} of Google Cloud data source {googleCloudDataSourceId} finished.
GET /v1/dataSources List all cloud data sources on the account · List Data Sources #
Ask an LLM
“Which cloud data sources have I imported into my Lucid account?”
“Can I see all my AWS, Azure and Google Cloud data sources in one list?”
Tell an agent
List all cloud data sources on my Lucid account.
Show me every imported cloud data source.
GET /v1/dataSources/{dataSourceId} Get details of one cloud data source · Get Data Source #
Ask an LLM
“What are the details of a specific cloud data source?”
“Can I see the link parameters of a cloud data source I created?”
Tell an agent
Show me cloud data source {dataSourceId}.
Get the details and link parameters for data source {dataSourceId}.
DELETE /v1/dataSources/{dataSourceId} Permanently delete a cloud data source · Delete Data Source #
Ask an LLM
“What happens to collections and items when I delete a cloud data source?”
“Can a deleted cloud data source be recovered afterwards?”
Tell an agent destructive · confirm first
Delete data source {dataSourceId} and all its collections, schema and items.
Permanently remove cloud data source {dataSourceId}.
GET /v1/documents/cloud/aws/viewTemplates List AWS view templates for cloud models · Get Supported AWS View Templates #
Ask an LLM
“Which view templates can I use when visualizing AWS data in a Lucid model?”
“What AWS diagram layouts does Lucid Cloud support?”
Tell an agent
List the supported AWS view templates.
Show me the view templates available for AWS models.
GET /v1/documents/cloud/azure/viewTemplates List Azure view templates for cloud models · Get Supported Azure View Templates #
Ask an LLM
“When I build an Azure model, which predefined views am I allowed to pick from?”
“What Azure diagram layouts does Lucid Cloud support?”
Tell an agent
List the supported Azure view templates.
Show me the view templates available for Azure models.
GET /v1/documents/cloud/googleCloud/viewTemplates List Google Cloud view templates for cloud models · Get Supported Google Cloud View Templates #
Ask an LLM
“Which view templates can I use when visualizing Google Cloud data in a Lucid model?”
“What Google Cloud diagram layouts does Lucid Cloud support?”
Tell an agent
List the supported Google Cloud view templates.
Show me the view templates available for Google Cloud models.
POST /v1/documents/cloud/aws Create a cloud model diagram from AWS data · Create Model from AWS Data Source #
Ask an LLM
“How do I generate an architecture diagram from my imported AWS data?”
“Can a new AWS model stay automatically synced with its data source?”
Tell an agent
Create a model titled {title} from AWS data sources {dataSources} with autosync {autosync}.
Visualize AWS data sources {dataSources} as {title} using view templates {viewTemplates}, autosync {autosync}.
GET /v1/documents/cloud/aws/{jobReferenceId}/status Check status of an AWS model creation job · Get "Create Model from AWS Data Source" Job Status #
Ask an LLM
“Is the diagram I requested from my AWS data ready yet?”
“What's the status of my AWS model creation job?”
Tell an agent
Check AWS model creation job {jobReferenceId}.
Tell me whether the AWS model from job {jobReferenceId} has been created.
POST /v1/documents/cloud/aws/{documentId}/sync Sync an AWS model with its data source · Sync Model with AWS Data Source #
Ask an LLM
“How do I bring an existing AWS diagram up to date with its data source?”
“Can I re-sync an AWS model after my infrastructure changed?”
Tell an agent
Sync AWS model document {documentId} with its data source.
Update the AWS diagram {documentId} to match the latest AWS data.
GET /v1/documents/cloud/aws/{documentId}/sync/{jobReferenceId}/status Check status of an AWS model sync job · Get "Sync Model with AWS Data Source" Job Status #
Ask an LLM
“Has the sync of my AWS model finished?”
“What's the progress of the job syncing my AWS diagram?”
Tell an agent
Check sync job {jobReferenceId} for AWS model {documentId}.
Tell me if AWS diagram {documentId} finished syncing in job {jobReferenceId}.
POST /v1/documents/cloud/azure Create a cloud model diagram from Azure data · Create Model from Azure Data Source #
Ask an LLM
“How do I generate an architecture diagram from my imported Azure data?”
“Can a new Azure model stay automatically synced with its data source?”
Tell an agent
Create a model titled {title} from Azure data sources {dataSources} with autosync {autosync}.
Visualize Azure data sources {dataSources} as {title} using view templates {viewTemplates}, autosync {autosync}.
GET /v1/documents/cloud/azure/{jobReferenceId}/status Check status of an Azure model creation job · Get "Create Model from Azure Data Source" Job Status #
Ask an LLM
“Is the diagram I requested from my Azure data ready yet?”
“What's the status of my Azure model creation job?”
Tell an agent
Check Azure model creation job {jobReferenceId}.
Tell me whether the Azure model from job {jobReferenceId} has been created.
POST /v1/documents/cloud/azure/{documentId}/sync Sync an Azure model with its data source · Sync Model with Azure Data Source #
Ask an LLM
“My Azure resources changed — can Lucid redraw the existing Azure diagram from fresh data?”
“Is there a way to sync an Azure model that wasn't set to autosync?”
Tell an agent
Sync Azure model document {documentId} with its data source.
Update the Azure diagram {documentId} to match the latest Azure data.
GET /v1/documents/cloud/azure/{documentId}/sync/{jobReferenceId}/status Check status of an Azure model sync job · Get "Sync Model with Azure Data Source" Job Status #
Ask an LLM
“Has the sync of my Azure model finished?”
“What's the progress of the job syncing my Azure diagram?”
Tell an agent
Check sync job {jobReferenceId} for Azure model {documentId}.
Tell me if Azure diagram {documentId} finished syncing in job {jobReferenceId}.
POST /v1/documents/cloud/googleCloud Create a cloud model diagram from Google Cloud data · Create Model from Google Cloud Data Source #
Ask an LLM
“Is there a way to generate an architecture diagram from my imported Google Cloud data?”
“Can a new Google Cloud model stay automatically synced with its data source?”
Tell an agent
Create a model titled {title} from Google Cloud data sources {dataSources} with autosync {autosync}.
Visualize Google Cloud data sources {dataSources} as {title} using view templates {viewTemplates}, autosync {autosync}.
GET /v1/documents/cloud/googleCloud/{jobReferenceId}/status Check status of a Google Cloud model creation job · Get "Create Model from Google Cloud Data Source" Job Status #
Ask an LLM
“Is the diagram I requested from my Google Cloud data ready yet?”
“What's the status of my Google Cloud model creation job?”
Tell an agent
Check Google Cloud model creation job {jobReferenceId}.
Tell me whether the Google Cloud model from job {jobReferenceId} has been created.
POST /v1/documents/cloud/googleCloud/{documentId}/sync Sync a Google Cloud model with its data source · Sync Model with Google Cloud Data Source #
Ask an LLM
“Can I bring an existing Google Cloud diagram up to date with its data source?”
“Is it possible to re-sync a Google Cloud model after my projects changed?”
Tell an agent
Sync Google Cloud model document {documentId} with its data source.
Update the Google Cloud diagram {documentId} to match the latest data.
GET /v1/documents/cloud/googleCloud/{documentId}/sync/{jobReferenceId}/status Check status of a Google Cloud model sync job · Get "Sync Model with Google Cloud Data Source" Job Status #
Ask an LLM
“Has the sync of my Google Cloud model finished?”
“What's the progress of the job syncing my Google Cloud diagram?”
Tell an agent
Check sync job {jobReferenceId} for Google Cloud model {documentId}.
Tell me if Google Cloud diagram {documentId} finished syncing in job {jobReferenceId}.

Documentation

📖
Documentation
https://developer.lucid.co/docs/welcome
📖
APIReference
https://developer.lucid.co/reference/api
📖
APIReference
https://developer.lucid.co/reference/overview-scim

Specifications

⚙
OpenAPI
https://artifacts.apis.io/lucid/openapi/lucid-cloud-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lucid:lucid-cloud-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lucid-cloud-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Lucid REST Cloud API
  version: '1.0'
  description: The Lucid REST API provides programmatic access to manage documents, users, folders, sharing, licensing, and audit logs across the Lucid Suite (Lucidchart, Lucidspark, and Lucidscale). Authenticate via OAuth 2.0 or API key.
  contact:
    name: Lucid Developer Platform
    url: https://developer.lucid.co/
  x-documentation: https://developer.lucid.co/reference/api
servers:
- url: https://api.lucid.co
tags:


# --- truncated at 32 KB (108 KB total) ---
# Full source: https://artifacts.apis.io/lucid/openapi/lucid-cloud-api-openapi.yml