Edge Impulse Organizations API
The Organizations API from Edge Impulse — 60 operation(s) for organizations.
Operations 80
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
“Which Edge Impulse organizations am I a member of?”
“Why does an API key only show one organization when I list them?”
Tell an agent
List the organizations I'm part of.
Show every active organization my account can access.
Ask an LLM
“How do I set up a brand-new organization for my team?”
“What do I need to provide to create an organization for myself?”
Tell an agent
Create a new organization named {organizationName}.
Set up my own organization called {organizationName}.
Ask an LLM
“Where do I see all the information about my organization?”
“What details, like name, logo and members, does an organization record hold?”
Tell an agent
Get the details of organization {organizationId}.
Show everything about my organization {organizationId}.
Ask an LLM
“How do I rename my organization or change its readme?”
“Can I set a monthly job compute limit on my own organization?”
Tell an agent
Rename my organization {organizationId} to {name}.
Update the readme of organization {organizationId} to {readme}.
DELETE
/api/organizations/{organizationId}
Permanently delete my organization · Remove organization
#
Ask an LLM
“Is deleting my organization and all its data reversible?”
“How do I remove my organization completely?”
Tell an agent destructive · confirm first
Delete my organization {organizationId} and all its data.
Irrevocably remove organization {organizationId}.
POST
/api/organizations/{organizationId}/trial/request-extension
Request an enterprise trial extension · Request trial extension
#
Ask an LLM
“My enterprise trial is ending; can I ask for more time?”
“What should I include when requesting a trial extension, like use case or timeline?”
Tell an agent
Request an enterprise trial extension for organization {organizationId} because {reason}.
Ask to extend trial {trialId} for organization {organizationId} with use case {useCase} and timeline {timeline}.
GET
/api/organizations/{organizationId}/metrics
Get usage metrics for my organization · Organization metrics
#
Ask an LLM
“What general usage metrics are available for my organization?”
“Can I exclude Edge Impulse staff from my organization's metrics?”
Tell an agent
Get general metrics for organization {organizationId}.
Show organization {organizationId} metrics only for {projectVisibility} projects.
POST
/api/organizations/{organizationId}/request-hr-block-license
Request a license for the HR block · Request HR block license
#
Ask an LLM
“What license do I need to deploy an impulse that uses the HR block?”
“How do I ask for the heart-rate block deployment license?”
Tell an agent
Request an HR block license for organization {organizationId}.
Ask for the heart-rate block deployment license on organization {organizationId}.
POST
/api/organizations/{organizationId}/limits-request
Request higher organization limits · Request organization limits increase
#
Ask an LLM
“Can I ask for more users, projects, compute or storage for my organization?”
“Which organization limits can I request to raise?”
Tell an agent
Request an increase of {limits} for organization {organizationId}.
Ask to raise organization {organizationId} limits to {limits} because {reason}.
GET
/api/organizations/{organizationId}/whitelabel
Get white label configuration · White Label Admin - Get white label information
#
Ask an LLM
“As a white label admin, where do I see my white label's configuration?”
“Which project types does my white label currently support?”
Tell an agent
Get the white label information for organization {organizationId}.
Show my white label settings via organization {organizationId}.
PUT
/api/organizations/{organizationId}/whitelabel
Update supported project types for a white label · White Label Admin - Update white label information
#
Ask an LLM
“How do I change which project types users can create in my white label?”
“Can a white label admin restrict the supported project types?”
Tell an agent
Set the supported project types of the white label for organization {organizationId} to {supportedProjectTypes}.
Limit white label {organizationId} to project types {supportedProjectTypes}.
POST
/api/organizations/{organizationId}/whitelabel/deploymentTargets
Choose enabled deployment targets for a white label · White Label Admin - Update deployment targets
#
Ask an LLM
“How do I enable or disable deployment targets across my white label?”
“Can I turn off certain hardware targets for everyone in my white label?”
Tell an agent
Enable deployment targets {targets} for the white label of organization {organizationId}.
Update which deployment targets white label {organizationId} offers to {targets}.
POST
/api/organizations/{organizationId}/whitelabel/deploymentTargets/default
Set the white label's default deployment target · White Label Admin - Update default deployment target
#
Ask an LLM
“Which deployment target is preselected for users of my white label, and can I change it?”
“How do I make one board the default deployment target in my white label?”
Tell an agent
Make {defaultDeploymentTarget} the default deployment target for white label {organizationId}.
Change the white label default target of organization {organizationId} to {defaultDeploymentTarget}.
POST
/api/organizations/{organizationId}/whitelabel/deploymentOptionsOrder
Reorder deployment options in the white label · White Label Admin - Update the order of deployment options in the deployment…
#
Ask an LLM
“Can I control the order deployment options appear in on the deployment page?”
“How do I put our preferred deployment options at the top for white label users?”
Tell an agent
Reorder the deployment options for white label {organizationId} as {order}.
Show deployment options in white label {organizationId} in the order {order}.
POST
/api/organizations/{organizationId}/whitelabel/learningBlocks
Choose enabled learning blocks for a white label · White Label Admin - Update learning blocks
#
Ask an LLM
“How do I limit which learning blocks are available in my white label?”
“Can a white label admin enable only certain learning blocks?”
Tell an agent
Enable learning blocks {learningBlocks} for white label {organizationId}.
Update the learning blocks white label {organizationId} offers to {learningBlocks}.
POST
/api/organizations/{organizationId}/whitelabel/theme/logo
Update the white label theme logo · White Label Admin - Update theme logo
#
Ask an LLM
“How do I replace the main logo shown across my white label?”
“Can a white label admin upload a new theme logo?”
Tell an agent
Upload {image} as the white label theme logo for organization {organizationId}.
Replace the main white label logo of organization {organizationId}.
POST
/api/organizations/{organizationId}/whitelabel/theme/deviceLogo
Update the white label device logo · White Label Admin - Update theme device logo
#
Ask an LLM
“Which logo appears on the devices page of my white label, and how do I change it?”
“Can I set a separate device logo for my white label theme?”
Tell an agent
Upload {image} as the white label device logo for organization {organizationId}.
Replace the device logo in white label {organizationId}'s theme.
POST
/api/organizations/{organizationId}/whitelabel/theme/colors
Update the white label theme colors · White Label Admin - Update theme colors
#
Ask an LLM
“How do I brand my white label with our primary color?”
“Can the white label theme use a gradient end color as well?”
Tell an agent
Set white label {organizationId} primary color to {primaryColor}.
Set the white label gradient end color for organization {organizationId} to {primaryColorGradientEnd}.
POST
/api/organizations/{organizationId}/whitelabel/theme/favicon
Update the white label favicon · White Label Admin - Update theme favicon
#
Ask an LLM
“How do I change the browser tab icon for my white label site?”
“Can a white label admin upload a custom favicon?”
Tell an agent
Upload {image} as the white label favicon for organization {organizationId}.
Replace white label {organizationId}'s tab icon with {image}.
GET
/api/organizations/{organizationId}/whitelabel/metrics
Get global white label metrics · White Label Admin - Get global white label metrics
#
Ask an LLM
“What global usage metrics can I see across my whole white label?”
“How many users and projects does my white label have overall?”
Tell an agent
Get global metrics for the white label of organization {organizationId}.
Show white label-wide usage numbers for {organizationId}.
GET
/api/organizations/{organizationId}/whitelabel/users
List all users in a white label · White Label Admin - Get all white label users
#
Ask an LLM
“How do I list every registered user in my white label?”
“Can I search white label users by name and filter by tier or active status?”
Tell an agent
List all users registered in white label {organizationId}.
Search white label {organizationId} users for {search}, {limit} per page.
GET
/api/organizations/{organizationId}/whitelabel/users/{userId}
Get a white label user's profile · White Label Admin - Get a white label user
#
Ask an LLM
“As a white label admin, how do I look up one user's account details?”
“What information can I see about a specific white label user?”
Tell an agent
Get white label user {userId} in organization {organizationId}.
Show the account of white label user {userId}.
POST
/api/organizations/{organizationId}/whitelabel/users/{userId}
Update a white label user · White Label Admin - Update white label user
#
Ask an LLM
“Can a white label admin suspend or activate a user's account?”
“How do I change a white label user's email, name or job title?”
Tell an agent
Suspend white label user {userId} in organization {organizationId} by setting suspended to {suspended}.
Change white label user {userId}'s email to {email}.
DELETE
/api/organizations/{organizationId}/whitelabel/users/{userId}
Delete a white label user · Delete a user
#
Ask an LLM
“How do I delete a user account from my white label?”
“Can a white label admin remove a user entirely?”
Tell an agent destructive · confirm first
Delete white label user {userId} from organization {organizationId}.
Remove user account {userId} from the white label.
GET
/api/organizations/{organizationId}/whitelabel/users/{userId}/metrics
Get marketing metrics for a white label user · White Label Admin - Get white label user metrics
#
Ask an LLM
“What marketing metrics are tracked for an individual white label user?”
“How engaged is a particular user in my white label?”
Tell an agent
Get marketing metrics for white label user {userId} in organization {organizationId}.
Show engagement metrics of white label user {userId}.
GET
/api/organizations/{organizationId}/whitelabel/users/{userId}/jobs
List a white label user's project jobs · White Label Admin - Get user jobs
#
Ask an LLM
“Which project jobs has a specific white label user run?”
“Can I page through all jobs started by one user in my white label?”
Tell an agent
List project jobs for white label user {userId} in organization {organizationId}.
Show {limit} jobs run by white label user {userId}.
GET
/api/organizations/{organizationId}/whitelabel/projects
List all projects in a white label · White Label Admin - Get all white label projects
#
Ask an LLM
“How do I see every project created across my white label?”
“Can I search white label projects by name or show only active ones?”
Tell an agent
List all projects in white label {organizationId}.
Search white label {organizationId} projects for {search}.
POST
/api/organizations/{organizationId}/whitelabel/projects
Create a free-tier project in a white label · White Label Admin - Create a new project within white label context
#
Ask an LLM
“As a white label admin, can I create a free-tier project on behalf of a user?”
“How do I create a white label project and assign an owner by email?”
Tell an agent
Create white label project {projectName} in organization {organizationId}.
Create a free-tier white label project {projectName} owned by {ownerEmail}.
GET
/api/organizations/{organizationId}/whitelabel/projects/{projectId}
Get a white label project's details · White Label Admin - Get a white label project
#
Ask an LLM
“How does a white label admin inspect any project in the white label?”
“What project information can I read as a white label admin?”
Tell an agent
Get white label project {projectId} in organization {organizationId}.
Show the details of white label project {projectId}.
POST
/api/organizations/{organizationId}/whitelabel/projects/{projectId}
Update a white label project's settings · White Label Admin - Update white label project
#
Ask an LLM
“Can a white label admin raise a project's compute time limit or enable GPU training?”
“How do I rename a project or change its visibility as a white label admin?”
Tell an agent
Set the compute time limit of white label project {projectId} in organization {organizationId} to {computeTimeLimitM} minutes.
Rename white label project {projectId} to {name}.
DELETE
/api/organizations/{organizationId}/whitelabel/projects/{projectId}
Delete a white label project · White Label Admin - Delete a project
#
Ask an LLM
“How does a white label admin delete someone's project?”
“Can I remove a project from my white label entirely?”
Tell an agent destructive · confirm first
Delete white label project {projectId} in organization {organizationId}.
Remove project {projectId} from the white label.
POST
/api/organizations/{organizationId}/whitelabel/projects/{projectId}/apiKeys
Add a temporary API key to a white label project · White Label Admin - Add Project API key
#
Ask an LLM
“Can a white label admin mint a temporary API key to act on a project's behalf?”
“How long does a white label project API key last, and can I set its TTL?”
Tell an agent
Add API key {name} to white label project {projectId} in organization {organizationId}.
Create a temporary project API key {name} for project {projectId} expiring after {ttl} seconds.
POST
/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members
Add a user to a white label project · White Label Admin - Add user to a project
#
Ask an LLM
“How does a white label admin add a member to any project?”
“What happens if I add to a white label project without naming a user?”
Tell an agent
Add {usernameOrEmail} to white label project {projectId} in organization {organizationId}.
Add myself to white label project {projectId}.
DELETE
/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members/{userId}
Remove a user from a white label project · White Label Admin - Remove user from a project
#
Ask an LLM
“How do I take a user off a project as a white label admin?”
“Can a white label admin revoke someone's project membership?”
Tell an agent destructive · confirm first
Remove user {userId} from white label project {projectId} in organization {organizationId}.
Revoke user {userId}'s membership of project {projectId} in the white label.
GET
/api/organizations/{organizationId}/whitelabel/projects/{projectId}/jobs
List jobs for a white label project · White Label Admin - Get project jobs
#
Ask an LLM
“What jobs have run in a given project across my white label?”
“Can a white label admin page through a project's job history?”
Tell an agent
Show the job history of project {projectId}, as white label admin of {organizationId}.
Show the last {limit} jobs of white label project {projectId}.
POST
/api/organizations/{organizationId}/whitelabel/development-boards
Add a development board to a white label · White Label Admin - Add a development board to a whitelabel
#
Ask an LLM
“How do I list our own hardware board in my white label?”
“What do I need, like an image and docs link, to add a development board?”
Tell an agent
Add development board {name} with image {image} and docs {docsUrl} to white label {organizationId}.
Register board {name} in the white label, documented at {docsUrl}, with image {image}.
PUT
/api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}
Update a white label development board · White Label Admin - Update a development board in a whitelabel
#
Ask an LLM
“Can I rename a development board or fix its documentation link?”
“How do I edit the details of a board already in my white label?”
Tell an agent
Rename development board {developmentBoardId} in white label {organizationId} to {name}.
Change the docs link of development board {developmentBoardId} to {docsUrl}.
DELETE
/api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}
Remove a development board from a white label · White Label Admin - Remove a development board from a whitelabel
#
Ask an LLM
“How do I take a development board out of my white label?”
“Can a white label admin delete a board that's no longer supported?”
Tell an agent destructive · confirm first
Remove development board {developmentBoardId} from white label {organizationId}.
Delete board {developmentBoardId} from the white label list.
POST
/api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}/image
Update a development board's image · White Label Admin - Update the image of a whitelabel development board
#
Ask an LLM
“How do I replace just the picture of a development board in my white label?”
“Can I upload a new photo for an existing board?”
Tell an agent
Upload {image} as the picture for development board {developmentBoardId} in white label {organizationId}.
Replace the photo of board {developmentBoardId}.
GET
/api/organizations/{organizationId}/whitelabel/organizations
List all organizations in a white label · White Label Admin - Get all organizations within a white label
#
Ask an LLM
“How do I see every organization inside my white label?”
“Can I include deleted organizations when listing the white label's orgs?”
Tell an agent
List all organizations in white label {organizationId}.
Search organizations in white label {organizationId} for {search}, including deleted ones.
POST
/api/organizations/{organizationId}/whitelabel/organizations
Create an organization inside a white label · White Label Admin - Create new organization within white label context
#
Ask an LLM
“As a white label admin, how do I create an organization for a customer?”
“Can I assign an admin by email when creating a white label organization?”
Tell an agent
Create organization {organizationName} inside white label {organizationId}.
Create white label organization {organizationName} with {adminEmail} as its admin.
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/computeTime
Get an organization's compute time usage · White Label Admin - Get organization compute time usage
#
Ask an LLM
“How much compute time did a customer organization use over a date range?”
“Can a white label admin check compute usage between two dates?”
Tell an agent
Get compute time usage for organization {innerOrganizationId} in white label {organizationId} from {startDate} to {endDate}.
Show compute minutes used by organization {innerOrganizationId} between {startDate} and {endDate}.
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports
List an organization's usage reports · White Label Admin - Get all usage reports
#
Ask an LLM
“Which usage reports already exist for a customer organization?”
“Can I page through generated usage reports as a white label admin?”
Tell an agent
List usage reports for organization {innerOrganizationId} in white label {organizationId}.
Show {limit} usage reports for organization {innerOrganizationId}.
POST
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports
Generate a usage report for an organization · White Label Admin - Creates a new usage report
#
Ask an LLM
“How do I generate a usage report for a customer organization over a period?”
“Does creating a usage report run as a background job?”
Tell an agent
Generate a usage report for organization {innerOrganizationId} in white label {organizationId} from {startDate} to {endDate}.
Start a usage report job for organization {innerOrganizationId} covering {startDate} through {endDate}.
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}
Get a usage report's details · White Label Admin - Get usage report
#
Ask an LLM
“Is my requested usage report ready yet, and what period does it cover?”
“How do I look up a single usage report by ID?”
Tell an agent
Get usage report {reportId} for organization {innerOrganizationId} in white label {organizationId}.
Check the status of usage report {reportId}.
DELETE
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}
Delete a usage report · White Label Admin - Delete usage report
#
Ask an LLM
“Can I delete an old usage report for a customer organization?”
“How do I remove a usage report I generated by mistake?”
Tell an agent destructive · confirm first
Delete usage report {reportId} for organization {innerOrganizationId} in white label {organizationId}.
Remove usage report {reportId}.
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}/download
Download a usage report · White Label Admin - Download usage report
#
Ask an LLM
“How do I download the file for a finished usage report?”
“Can I save a customer organization's usage report locally?”
Tell an agent
Download usage report {reportId} for organization {innerOrganizationId} in white label {organizationId}.
Save the file of usage report {reportId}.
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports
List a customer organization's data exports · White Label Admin - Get all organization data exports
#
Ask an LLM
“As a white label admin, which data exports exist for a customer organization?”
“Can I page through another organization's exports from the white label?”
Tell an agent
List data exports for organization {innerOrganizationId} in white label {organizationId}.
Show {limit} white label data exports for organization {innerOrganizationId}.
POST
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports
Create a data export for an organization · White Label Admin - Create a new organization data export
#
Ask an LLM
“How does a white label admin export all of a customer organization's data?”
“Can I set an expiration date on an organization data export?”
Tell an agent
Create a data export described as {description} for organization {innerOrganizationId} in white label {organizationId}.
Export organization {innerOrganizationId}'s data as {description}, expiring on {expirationDate}.
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}
Get a customer organization's data export · White Label Admin - Get organization data export
#
Ask an LLM
“As a white label admin, how do I check one export of a customer organization?”
“Is a white label data export finished and when does it expire?”
Tell an agent
Get data export {exportId} for organization {innerOrganizationId} in white label {organizationId}.
Check white label export {exportId} of organization {innerOrganizationId}.
DELETE
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}
Delete an organization data export · White Label Admin - Delete organization data export
#
Ask an LLM
“How do I delete a data export I made for a customer organization?”
“Can a white label admin remove an export before it expires?”
Tell an agent destructive · confirm first
Delete data export {exportId} for organization {innerOrganizationId} in white label {organizationId}.
Remove white label export {exportId} now.
PUT
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}
Update a data export's description or expiry · White Label Admin - Update organization data export
#
Ask an LLM
“Can I extend the expiration date of an organization data export?”
“How do I change the description of an existing export?”
Tell an agent
Set the expiration of export {exportId} for organization {innerOrganizationId} in white label {organizationId} to {expirationDate}.
Change the description of export {exportId} to {description}.
POST
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/apiKeys
Add a temporary API key to an organization · White Label Admin - Add organization API key
#
Ask an LLM
“Can a white label admin get a temporary key to call the Organizations API for a customer org?”
“How long can a white label-issued organization API key stay valid?”
Tell an agent
Add a temporary API key to organization {innerOrganizationId} in white label {organizationId}.
Create an organization API key for {innerOrganizationId} that expires after {ttl} seconds.
POST
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/members
Add a user to a white label organization · White Label Admin - Add user to an organization
#
Ask an LLM
“How does a white label admin add a user to a customer organization with a role?”
“Which datasets does a guest added by a white label admin get access to?”
Tell an agent
Add {usernameOrEmail} to organization {innerOrganizationId} in white label {organizationId} as {role} with datasets {datasets}.
Add myself to white label organization {innerOrganizationId} as {role} with access to {datasets}.
DELETE
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/members/{userId}
Remove a user from a white label organization · White Label Admin - Remove user from an organization
#
Ask an LLM
“How does a white label admin remove someone from a customer organization?”
“Can I revoke a user's organization membership from the white label console?”
Tell an agent destructive · confirm first
As white label admin of {organizationId}, kick user {userId} out of customer organization {innerOrganizationId}.
Revoke user {userId}'s membership in white label organization {innerOrganizationId}.
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}
Get a white label organization's details · White Label Admin - Get organization information
#
Ask an LLM
“As a white label admin, how do I view a customer organization's full details?”
“Can I look up an organization in my white label even after it was deleted?”
Tell an agent
Get the details of organization {innerOrganizationId} in white label {organizationId}.
Show white label organization {innerOrganizationId}, including if deleted.
POST
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}
Update a white label organization's settings · White Label Admin - Update organization
#
Ask an LLM
“Can a white label admin mark a customer organization billable or set its contract start date?”
“How do I change the entitlement limits of an organization in my white label?”
Tell an agent
Set entitlement limits of organization {innerOrganizationId} in white label {organizationId} to {entitlementLimits}.
Set the contract start date of white label organization {innerOrganizationId} to {contractStartDate}.
DELETE
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}
Delete an organization from a white label · White Label Admin - Delete an organization
#
Ask an LLM
“How does a white label admin delete a customer organization?”
“Can a deleted white label organization be brought back later?”
Tell an agent destructive · confirm first
Delete organization {innerOrganizationId} from white label {organizationId}.
Remove customer organization {innerOrganizationId} from the white label.
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/restore
Restore a deleted organization · White Label Admin - Restore an organization
#
Ask an LLM
“How do I undo the deletion of an organization in my white label?”
“Are an organization's projects restored too when I bring it back?”
Tell an agent
Restore deleted organization {innerOrganizationId} in white label {organizationId}.
Undelete organization {innerOrganizationId} and its projects.
POST
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/projects
Create a project for a white label organization · White Label Admin - Create a new organization project
#
Ask an LLM
“Can a white label admin create a project inside a customer organization?”
“How do I create an organization project and set its owner from the white label?”
Tell an agent
Inside customer organization {innerOrganizationId} (white label {organizationId}), set up a new project called {projectName}.
Create a {projectVisibility} project {projectName} for white label organization {innerOrganizationId} owned by {ownerEmail}.
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/jobs
List jobs for a white label organization · White Label Admin - Get organization jobs
#
Ask an LLM
“What jobs has a customer organization run, as seen by the white label admin?”
“Can I page through an organization's job history from the white label?”
Tell an agent
Show every job run by customer organization {innerOrganizationId}, viewed from white label {organizationId}.
Show the latest {limit} jobs of white label organization {innerOrganizationId}.
POST
/api/organizations/{organizationId}/logo
Upload my organization's logo · Upload organization logo
#
Ask an LLM
“How do I upload a logo for my organization?”
“Can I replace the organization logo with a new image file?”
Tell an agent
Upload {image} as the logo of organization {organizationId}.
Replace my organization {organizationId} logo.
POST
/api/organizations/{organizationId}/header
Upload my organization's header image · Upload organization header image
#
Ask an LLM
“How do I set a banner header image on my organization page?”
“Can I upload a new organization header without touching the logo?”
Tell an agent
Upload {image} as the header image of organization {organizationId}.
Replace the banner on organization {organizationId}'s page.
GET
/api/organizations/{organizationId}/test-admin
Check admin access to an organization · Admin endpoint
#
Ask an LLM
“Is there a quick way to test whether my credentials have admin rights on an organization?”
“How can I confirm I'm an organization admin before running admin calls?”
Tell an agent
Test whether I have admin rights on organization {organizationId}.
Call the admin test endpoint for organization {organizationId}.
Ask an LLM
“Which projects belong to my organization?”
“Can I get every project my organization owns in one call?”
Tell an agent
List all projects of organization {organizationId}.
Show the projects owned by my organization {organizationId}.
Ask an LLM
“What API keys exist for my organization?”
“Why do organization API keys only show part of the key when listed?”
Tell an agent
List the API keys of organization {organizationId}.
Show the masked API keys for my organization {organizationId}.
Ask an LLM
“How do I create a new API key for my organization with a specific role?”
“Can I supply my own key value when adding an organization API key?”
Tell an agent
Add API key {name} with role {role} to organization {organizationId}.
Create organization API key {name} as {role} using the value {apiKey}.
DELETE
/api/organizations/{organizationId}/apikeys/{apiKeyId}
Revoke an organization API key · Revoke API key
#
Ask an LLM
“How do I revoke a leaked organization API key?”
“Can I disable one organization key without affecting the others?”
Tell an agent destructive · confirm first
Revoke API key {apiKeyId} on organization {organizationId}.
Disable organization key {apiKeyId} now.
POST
/api/organizations/{organizationId}/members/add
Add an existing user to my organization · Add member
#
Ask an LLM
“How do I add someone who already has an account to my organization?”
“Can I give a new organization member access to only certain datasets?”
Tell an agent
Add {usernameOrEmail} to organization {organizationId} as {role} with datasets {datasets}.
Make existing user {usernameOrEmail} a {role} in my organization with access to {datasets}.
POST
/api/organizations/{organizationId}/members/invite
Invite someone to my organization by email · Invite member
#
Ask an LLM
“How do I email an invitation to join my organization?”
“Can I invite a colleague who doesn't have an account yet?”
Tell an agent
Invite {email} to organization {organizationId} as {role} with datasets {datasets}.
Send an organization invitation to {email} for role {role} covering {datasets}.
POST
/api/organizations/{organizationId}/members/remove
Remove a member from my organization · Remove member
#
Ask an LLM
“How do I remove someone from my organization?”
“Why can't I remove the last remaining member of an organization?”
Tell an agent destructive · confirm first
Remove member {id} from organization {organizationId}.
Take member {id} out of my organization.
POST
/api/organizations/{organizationId}/members/{memberId}/role
Change a member's role in my organization · Set member role
#
Ask an LLM
“How do I promote an organization member to admin?”
“Can I change a member from member to guest?”
Tell an agent
Set the role of member {memberId} in organization {organizationId} to {role}.
Promote organization member {memberId} to {role}.
POST
/api/organizations/{organizationId}/members/{memberId}/datasets
Set which datasets a guest member can access · Set member datasets
#
Ask an LLM
“How do I restrict a guest member to specific datasets?”
“Can I change the datasets a guest in my organization can see?”
Tell an agent
Give guest member {memberId} of organization {organizationId} access to datasets {datasets}.
Limit guest {memberId} to datasets {datasets}.
POST
/api/organizations/{organizationId}/members/{memberId}/resend-invite
Resend an organization invitation · Resend invitation
#
Ask an LLM
“A colleague lost their invite email; can I send it again?”
“How do I resend a pending organization invitation?”
Tell an agent
Resend the invitation to member {memberId} of organization {organizationId}.
Send member {memberId} their organization invite again.
POST
/api/organizations/{organizationId}/readme/upload-image
Upload an image for the organization readme · Upload image for readme
#
Ask an LLM
“How do I add a picture to my organization's readme?”
“Where does an uploaded readme image get hosted, and what path do I get back?”
Tell an agent
Upload {image} for the readme of organization {organizationId}.
Host readme image {image} on the CDN and give me its path.
GET
/api/organizations/{organizationId}/exports
List my organization's data exports · Get all organization data exports
#
Ask an LLM
“Which data exports has my own organization created?”
“Can I page through my organization's exports?”
Tell an agent
List data exports for my organization {organizationId}.
Show {limit} of my organization {organizationId}'s exports.
GET
/api/organizations/{organizationId}/exports/{exportId}
Get one of my organization's data exports · Get organization data export
#
Ask an LLM
“Is my organization's data export ready to download yet?”
“How do I check the details of one of my own organization's exports?”
Tell an agent
Get data export {exportId} of my organization {organizationId}.
Check whether my export {exportId} has finished.
GET
/api/organizations/{organizationId}/exports/{exportId}/download
Download my organization's data export · Download organization data export
#
Ask an LLM
“How do I download the files of a finished organization data export?”
“Can I save my organization's exported data locally?”
Tell an agent
Download data export {exportId} from my organization {organizationId}.
Save the contents of my organization export {exportId}.
POST
/api/organizations/{organizationId}/multi-project-deployment/start
Build a deployment combining several projects' impulses · Create multi-project deployment
#
Ask an LLM
“Can I bundle impulses from multiple projects into one deployment?”
“Which inference engine is used when building a multi-project deployment?”
Tell an agent
Create a multi-project deployment in organization {organizationId} for impulses {impulses} using engine {engine}.
Combine impulses {impulses} into one {engine} build.
GET
/api/organizations/{organizationId}/multi-project-deployment/jobs/{jobId}/download
Download a multi-project deployment build · Download multi-project deployment
#
Ask an LLM
“Where do I download the output of a finished multi-project deployment job?”
“How do I fetch the combined build after the multi-project job completes?”
Tell an agent
Download multi-project deployment job {jobId} from organization {organizationId}.
Get the combined deployment built by job {jobId}.