Edge Impulse Admin API
The Admin API from Edge Impulse — 49 operation(s) for admin.
Operations 72
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
Ask an LLM
“As an admin, where do I see the global metrics for the whole Edge Impulse platform?”
“What platform-wide numbers can an administrator pull right now?”
Tell an agent
Get the admin global metrics.
Show me the current platform-wide admin metrics snapshot.
Ask an LLM
“Which global metrics reports have been generated so far?”
“Can I page through the list of saved platform metrics reports?”
Tell an agent
List the global metrics reports.
Show {limit} global metrics reports starting at offset {offset}.
POST
/api/admin/metrics/reports
Generate a global metrics report for a date range · Create a new global metrics report
#
Ask an LLM
“How do I generate a platform metrics report for last quarter?”
“Does creating a global metrics report run as a background job?”
Tell an agent
Create a global metrics report from {startDate} to {endDate}.
Start a job to build the platform metrics report covering {startDate} through {endDate}.
GET
/api/admin/metrics/reports/{reportId}
Get one global metrics report · Get global metrics report
#
Ask an LLM
“Is a specific global metrics report ready, and what period does it cover?”
“Can I look up a single platform metrics report by its id?”
Tell an agent
Get global metrics report {reportId}.
Show the status and details of platform metrics report {reportId}.
DELETE
/api/admin/metrics/reports/{reportId}
Delete a global metrics report · Delete global metrics report
#
Ask an LLM
“How do I remove an old global metrics report?”
“Can an admin delete a platform metrics report by id?”
Tell an agent destructive · confirm first
Delete global metrics report {reportId}.
Remove the platform metrics report {reportId} permanently.
GET
/api/admin/metrics/reports/{reportId}/download
Download a global metrics report · Download global metrics report
#
Ask an LLM
“Where do I download the file for a finished global metrics report?”
“Can I save a platform metrics report locally?”
Tell an agent
Download global metrics report {reportId}.
Fetch the file for platform metrics report {reportId}.
Ask an LLM
“Which data migrations exist on the platform infrastructure?”
“As an admin, can I see every infrastructure data migration?”
Tell an agent
List all data migrations.
Show the infrastructure data migrations and their state.
Ask an LLM
“What is the state of a particular data migration?”
“Is a given data migration currently running or paused?”
Tell an agent
Get data migration {migrationId}.
Show whether data migration {migrationId} is running.
POST
/api/admin/infra/migrations/{migrationId}
Run or pause a data migration · Run or pause a data migration
#
Ask an LLM
“How do I pause a data migration that is in progress?”
“Can an admin start a paused data migration again?”
Tell an agent
Set data migration {migrationId} (id {id}) to run state {shouldRun}.
Pause migration {migrationId} by sending id {id} with shouldRun {shouldRun}.
GET
/api/admin/infra/disallowedEmailDomains
List blocked signup email domains · Get the list of disallowed email domains
#
Ask an LLM
“Which email domains are blocked from signing up?”
“What does the disallowed email domain list currently contain?”
Tell an agent
List the disallowed email domains.
Show every email domain currently blocked from registration.
PUT
/api/admin/infra/disallowedEmailDomains
Block an email domain from signing up · Add a disallowed email domain
#
Ask an LLM
“How do I stop people with a throwaway email domain from registering?”
“Can an admin add a domain to the disallowed email list?”
Tell an agent
Add {domain} to the disallowed email domains.
Block signups from email domain {domain}.
DELETE
/api/admin/infra/disallowedEmailDomains/{domainName}
Unblock a disallowed email domain · Delete disallowed email domain
#
Ask an LLM
“How do I allow a previously blocked email domain to sign up again?”
“Can I take a domain off the disallowed email list?”
Tell an agent destructive · confirm first
Remove {domainName} from the disallowed email domains.
Unblock email domain {domainName} for registration.
Ask an LLM
“Which feature flags exist and which are switched on?”
“Where can an admin review all platform feature flags?”
Tell an agent
List all feature flags.
Show every platform feature flag and its state.
PUT
/api/admin/infra/featureFlags/{featureId}
Turn a feature flag on for everyone · Set a feature flag ON
#
Ask an LLM
“How do I enable a feature for all users at once?”
“What happens when an admin switches a feature flag on?”
Tell an agent
Turn feature flag {featureId} on.
Enable feature {featureId} for all users.
DELETE
/api/admin/infra/featureFlags/{featureId}
Turn a feature flag off for everyone · Set a feature flag OFF
#
Ask an LLM
“How do I disable a feature for every user?”
“Does switching a feature flag off delete the flag?”
Tell an agent destructive · confirm first
Turn feature flag {featureId} off.
Disable feature {featureId} for all users by deleting its flag.
Ask an LLM
“What Studio configuration values are set on the platform?”
“Can an admin list every Studio config key and value?”
Tell an agent
Get all Studio config items.
Show the full Studio configuration.
POST
/api/admin/infra/config/{configKey}
Update a Studio configuration item · Update studio config
#
Ask an LLM
“How do I change a single Studio config value?”
“Can an admin set a new value for a Studio configuration key?”
Tell an agent
Set Studio config {configKey} to {value}.
Update the Studio configuration item {configKey} with value {value}.
DELETE
/api/admin/infra/config/{configKey}
Delete a Studio configuration item · Delete a studio config item
#
Ask an LLM
“How do I remove a Studio config key entirely?”
“Can an admin delete one Studio configuration item?”
Tell an agent destructive · confirm first
Delete Studio config item {configKey}.
Remove the {configKey} key from Studio configuration.
Ask an LLM
“How can an admin search every registered user by name or email?”
“Can I list only active users on a particular tier?”
Tell an agent
List all registered users.
Search users matching {search}.
Ask an LLM
“What account information does the platform hold for a specific user?”
“Can an admin look up a user by their user id?”
Tell an agent
Get user {userId}.
Show the account details for user {userId}.
Ask an LLM
“How does an admin change a user's email or name?”
“Can I suspend or activate a user account?”
Tell an agent
Change the email of user {userId} to {email}.
Set the suspended status of user {userId} to {suspended}.
Ask an LLM
“How does an admin delete a user's account?”
“Can a user be removed from the platform entirely by id?”
Tell an agent destructive · confirm first
Delete user {userId}.
Permanently remove the account of user {userId}.
Ask an LLM
“What marketing metrics do we have about a particular user?”
“Can an admin see engagement numbers for one user?”
Tell an agent
Get marketing metrics for user {userId}.
Show the usage and marketing metrics of user {userId}.
Ask an LLM
“How do I change which permissions a user has?”
“Can an admin replace a user's permission list?”
Tell an agent
Set the permissions of user {userId} to {permissions}.
Grant user {userId} the permission list {permissions}.
Ask an LLM
“Which project jobs has a specific user run?”
“Can an admin page through one user's jobs?”
Tell an agent
List the jobs for user {userId}.
Show {limit} project jobs run by user {userId}.
Ask an LLM
“How does an admin give a user an enterprise trial?”
“Can I set the expiration date and organization name when creating a trial?”
Tell an agent
Create an enterprise trial for user {userId}.
Start an enterprise trial for user {userId} named {organizationName} that expires on {expirationDate}.
Ask an LLM
“When does a particular enterprise trial expire?”
“Can an admin look up the details of one enterprise trial?”
Tell an agent
Get enterprise trial {enterpriseTrialId}.
Show the expiration and notes for enterprise trial {enterpriseTrialId}.
PUT
/api/admin/trials/{enterpriseTrialId}
Extend or annotate an enterprise trial · Update enterprise trial
#
Ask an LLM
“How do I extend an enterprise trial's expiration date?”
“Can I add notes to an existing enterprise trial?”
Tell an agent
Extend enterprise trial {enterpriseTrialId} to {expirationDate}.
Set the notes on enterprise trial {enterpriseTrialId} to {notes}.
Ask an LLM
“How do I cancel and remove an enterprise trial?”
“Can an admin delete an enterprise trial by id?”
Tell an agent destructive · confirm first
Delete enterprise trial {enterpriseTrialId}.
Remove the enterprise trial {enterpriseTrialId} from the platform.
POST
/api/admin/trials/{enterpriseTrialId}/upgrade
Convert a trial to a full enterprise account · Upgrade enterprise trial to a full enterprise account
#
Ask an LLM
“How do I convert an enterprise trial into a paid enterprise account?”
“Can an admin upgrade a trial to full enterprise?”
Tell an agent
Upgrade enterprise trial {enterpriseTrialId} to a full enterprise account.
Turn trial {enterpriseTrialId} into a permanent enterprise organization.
Ask an LLM
“How can an admin search across every project on the platform?”
“Can I list only active projects, sorted my way?”
Tell an agent
List all projects on the platform.
Search all projects for {search}.
Ask an LLM
“How does an admin create a free tier project on behalf of a user?”
“Can I set the owner by email when creating a free project?”
Tell an agent
Create a free-tier project named {projectName}.
Create free project {projectName} owned by {ownerEmail}.
Ask an LLM
“As an admin, how do I look up any user's project details?”
“What information does the platform hold about a specific project?”
Tell an agent
Get project {projectId} as an admin.
Show admin details for project {projectId}.
Ask an LLM
“How can an admin raise a project's compute time limit?”
“Can I turn on GPU training or change visibility for someone's project?”
Tell an agent
Set the compute time limit of project {projectId} to {computeTimeLimitM} minutes.
Change the visibility of project {projectId} to {projectVisibility}.
Ask an LLM
“How does an admin delete someone's project?”
“Can any project be removed by id from the admin API?”
Tell an agent destructive · confirm first
Delete project {projectId} as an admin.
Permanently remove project {projectId} from the platform.
Ask an LLM
“How does an admin add someone to a project by username or email?”
“If I don't name a user, who gets added to the project?”
Tell an agent
Add {usernameOrEmail} as a member of project {projectId}.
Add myself to project {projectId} through the members endpoint.
DELETE
/api/admin/projects/{projectId}/members/{userId}
Remove a user from a project · Remove user from a project
#
Ask an LLM
“How does an admin remove a specific user from a project?”
“Can I kick a member out of someone's project by user id?”
Tell an agent destructive · confirm first
Remove user {userId} from project {projectId}.
Take member {userId} off project {projectId}.
GET
/api/admin/projects/{projectId}/jobs
List all jobs for a project as an admin · Get project jobs
#
Ask an LLM
“Which jobs have run in a specific project?”
“Can an admin page through the job list of any project?”
Tell an agent
List the jobs for project {projectId}.
Show {limit} jobs from project {projectId} starting at offset {offset}.
Ask an LLM
“How can an admin search every organization on the platform?”
“Can I include soft-deleted organizations in the list?”
Tell an agent
List all organizations.
Search organizations for {search}, including deleted ones.
Ask an LLM
“How does an admin create a new organization?”
“Can I assign an admin user when creating an organization?”
Tell an agent
Create an organization named {organizationName}.
Create organization {organizationName} with user {adminId} as its admin.
GET
/api/admin/organizations/{organizationId}
Get an organization's full details · Organization information
#
Ask an LLM
“What does the platform know about a specific organization?”
“Can an admin view details of a soft-deleted organization?”
Tell an agent
Get all information about organization {organizationId}.
Show organization {organizationId} details even if it was deleted.
POST
/api/admin/organizations/{organizationId}
Update an organization's properties · Update organization
#
Ask an LLM
“How does an admin rename an organization or change its logo?”
“Can I mark an organization as billable and set its contract start date?”
Tell an agent
Rename organization {organizationId} to {name}.
Set organization {organizationId} billable to {billable} with contract start {contractStartDate}.
Ask an LLM
“How does an admin delete an organization?”
“What is the difference between a soft delete and a full deletion of an organization?”
Tell an agent destructive · confirm first
Soft delete organization {organizationId}.
Fully delete organization {organizationId} including its identifiable data and files ({fullDeletion}).
POST
/api/admin/organizations/{organizationId}/restore
Restore a soft-deleted organization · Restore an organization
#
Ask an LLM
“Can I bring back an organization that was soft deleted?”
“Are an organization's projects restored along with it?”
Tell an agent
Restore organization {organizationId}.
Undo the deletion of organization {organizationId} and its projects.
GET
/api/admin/organizations/{organizationId}/usage/computeTime
Get an organization's compute time usage · Get organization compute time usage
#
Ask an LLM
“How much compute time did an organization use last month?”
“Can an admin see compute usage for an organization between two dates?”
Tell an agent
Get compute time usage for organization {organizationId} from {startDate} to {endDate}.
Show how many compute minutes organization {organizationId} consumed between {startDate} and {endDate}.
GET
/api/admin/organizations/{organizationId}/usage/reports
List an organization's usage reports · Get all usage reports
#
Ask an LLM
“Which usage reports have been generated for an organization?”
“Can I page through an organization's saved usage reports?”
Tell an agent
List the usage reports for organization {organizationId}.
Show {limit} usage reports for organization {organizationId}.
POST
/api/admin/organizations/{organizationId}/usage/reports
Generate a usage report for an organization · Creates a new usage report
#
Ask an LLM
“How do I generate a usage report for an organization for a billing period?”
“Is an organization usage report built by a background job?”
Tell an agent
Create a usage report for organization {organizationId} from {startDate} to {endDate}.
Start a job building organization {organizationId}'s usage report for {startDate} through {endDate}.
GET
/api/admin/organizations/{organizationId}/usage/reports/{reportId}
Get one organization usage report · Get usage report
#
Ask an LLM
“Is an organization's usage report finished processing?”
“Can I look up a single usage report for an organization?”
Tell an agent
Get usage report {reportId} for organization {organizationId}.
Show the status of organization {organizationId} usage report {reportId}.
DELETE
/api/admin/organizations/{organizationId}/usage/reports/{reportId}
Delete an organization usage report · Delete usage report
#
Ask an LLM
“How do I delete an old usage report from an organization?”
“Can an admin remove a specific organization usage report?”
Tell an agent destructive · confirm first
Delete usage report {reportId} from organization {organizationId}.
Remove organization {organizationId}'s usage report {reportId}.
GET
/api/admin/organizations/{organizationId}/usage/reports/{reportId}/download
Download an organization usage report · Download usage report
#
Ask an LLM
“Where do I download the file for an organization's usage report?”
“Can I save an organization usage report to share with billing?”
Tell an agent
Download usage report {reportId} for organization {organizationId}.
Fetch the usage report file {reportId} of organization {organizationId}.
POST
/api/admin/organizations/{organizationId}/members
Add a user to an organization with a role · Add user to an organization
#
Ask an LLM
“How does an admin add someone to an organization with a specific role?”
“Which datasets does a new organization member get access to?”
Tell an agent
Add {usernameOrEmail} to organization {organizationId} as {role} with access to datasets {datasets}.
Add myself to organization {organizationId} with role {role} and datasets {datasets}.
DELETE
/api/admin/organizations/{organizationId}/members/{userId}
Remove a user from an organization · Remove user from an organization
#
Ask an LLM
“How does an admin remove a member from an organization?”
“Can I take a specific user out of an organization by id?”
Tell an agent destructive · confirm first
Remove user {userId} from organization {organizationId}.
Revoke organization {organizationId} membership for user {userId}.
POST
/api/admin/organizations/{organizationId}/projects
Create a project inside an organization · Create a new organization project
#
Ask an LLM
“How does an admin create a new project that belongs to an organization?”
“Can I set the owner of a new organization project?”
Tell an agent
Create project {projectName} in organization {organizationId}.
Create organization {organizationId} project {projectName} owned by {ownerEmail}.
GET
/api/admin/organizations/{organizationId}/exports
List an organization's data exports · Get all organization data exports
#
Ask an LLM
“Which data exports have been made for an organization?”
“Can an admin page through an organization's export history?”
Tell an agent
List the data exports for organization {organizationId}.
Show {limit} data exports of organization {organizationId}.
POST
/api/admin/organizations/{organizationId}/exports
Export an organization's data · Create a new organization data export
#
Ask an LLM
“How do I export all of an organization's data?”
“Can I set an expiration date on an organization data export?”
Tell an agent
Create a data export for organization {organizationId} described as {description}.
Start an organization {organizationId} data export {description} that expires on {expirationDate}.
GET
/api/admin/organizations/{organizationId}/exports/{exportId}
Get one organization data export · Get organization data export
#
Ask an LLM
“Is an organization's data export ready to download?”
“Can I see the details of a single organization data export?”
Tell an agent
Get data export {exportId} for organization {organizationId}.
Show the status of organization {organizationId} export {exportId}.
DELETE
/api/admin/organizations/{organizationId}/exports/{exportId}
Delete an organization data export · Delete organization data export
#
Ask an LLM
“How do I remove an organization's data export?”
“Can an admin delete a data export before it expires?”
Tell an agent destructive · confirm first
Delete data export {exportId} from organization {organizationId}.
Remove organization {organizationId}'s export {exportId} now.
PUT
/api/admin/organizations/{organizationId}/exports/{exportId}
Change an organization data export · Update organization data export
#
Ask an LLM
“How do I extend the expiration of an organization's data export?”
“Can I edit the description of an existing data export?”
Tell an agent
Set the expiration of export {exportId} in organization {organizationId} to {expirationDate}.
Update the description of organization {organizationId} export {exportId} to {description}.
GET
/api/admin/organizations/{organizationId}/jobs
List an organization's jobs as an admin · Get organization jobs
#
Ask an LLM
“As an admin, which jobs has a given organization run?”
“Can I page through any organization's jobs from the admin API?”
Tell an agent
List the jobs of organization {organizationId} as an admin.
Show {limit} admin-visible jobs for organization {organizationId}.
Ask an LLM
“Which domains have single sign-on configured on the platform?”
“Where can an admin see the overall SSO setup?”
Tell an agent
Get the platform SSO settings.
Show every domain's single sign-on configuration.
GET
/api/admin/sso/{domainName}
Get identity providers for an SSO domain · Get SSO settings for a domain
#
Ask an LLM
“As an admin, which identity providers are enabled for a specific domain?”
“Can I check one domain's SSO configuration from the admin API?”
Tell an agent
Get the SSO identity providers configured for domain {domainName}.
Show the admin SSO settings for {domainName}.
PUT
/api/admin/sso/{domainName}
Set identity providers for an SSO domain · Add or update SSO settings for a domain
#
Ask an LLM
“How do I enable single sign-on for a company's email domain?”
“Can I replace the list of identity providers for a domain?”
Tell an agent
Set the identity providers for domain {domainName} to {idps}.
Enable SSO on {domainName} using providers {idps}.
DELETE
/api/admin/sso/{domainName}
Remove SSO settings for a domain · Delete SSO settings for a domain
#
Ask an LLM
“How do I turn off single sign-on for a domain?”
“Can an admin delete a domain's identity provider list?”
Tell an agent destructive · confirm first
Delete the SSO settings for domain {domainName}.
Remove all identity providers configured for {domainName}.
GET
/api/admin/jobs/{jobId}/details
Get a job's execution details with child jobs · Get job execution details
#
Ask an LLM
“How can an admin see the full execution tree of a job, including inner jobs?”
“Can I include child jobs when looking at a job's execution details?”
Tell an agent
Get execution details for job {jobId} with parent type {parentType}.
Show job {jobId} ({parentType}) details including its children jobs.
Ask an LLM
“As an admin, how do I read the logs of any job on the platform?”
“Can I page through an admin job log with limit and offset?”
Tell an agent
Get {limit} log lines from offset {offset} for job {jobId} with parent type {parentType}.
Show the admin logs for {parentType} job {jobId}, {limit} lines starting at {offset}.
Ask an LLM
“How much CPU and memory did a Kubernetes job use?”
“Can an admin see resource usage metrics for a job?”
Tell an agent
Get CPU and memory metrics for job {jobId} with parent type {parentType}.
Show resource usage of {parentType} job {jobId}.
GET
/api/admin/emails/{email}/verification-code
Get a trial email verification code · Get enterprise trial email verification code
#
Ask an LLM
“How can an admin retrieve the enterprise trial verification code sent to an email?”
“What verification code was issued for a trial signup address?”
Tell an agent
Get the enterprise trial verification code for {email}.
Look up the trial email verification code sent to {email}.
Ask an LLM
“Is there an older admin endpoint to find a single user by username or email?”
“Can I still look up a user with the deprecated find-user call?”
Tell an agent
Find the user matching {query} using the deprecated find-user endpoint.
Use the legacy lookup to find user {query}.
Ask an LLM
“Is there a deprecated call that returns every user ID?”
“Can I get a bare list of all user ids from the older admin endpoint?”
Tell an agent
Get all user IDs from the deprecated users-ids endpoint.
List every user id using the legacy admin call.
GET
/api/admin/users-ids/active
List user IDs active in the last 30 days · Get all user IDs (active last 30 days)
#
Ask an LLM
“Which users have been active in the last 30 days?”
“Can the deprecated endpoint return only recently active user ids?”
Tell an agent
Get the IDs of users active in the past 30 days.
List recently active user ids with the legacy admin endpoint.
POST
/api/admin/projects/{projectId}/add
Add yourself to a project (deprecated) · Add current user to a project
#
Ask an LLM
“Is there an older admin endpoint that just adds me to a project?”
“Can I still use the deprecated add call to join a project as admin?”
Tell an agent
Add me to project {projectId} using the deprecated add endpoint.
Join project {projectId} as the current admin via the legacy call.
POST
/api/admin/projects/{projectId}/remove
Remove yourself from a project (deprecated) · Remove current user from a project
#
Ask an LLM
“Is there a legacy endpoint to remove myself from a project as admin?”
“Can I still leave a project with the deprecated remove call?”
Tell an agent destructive · confirm first
Remove me from project {projectId} using the deprecated remove endpoint.
Leave project {projectId} as the current admin via the legacy call.