# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Edge Impulse Organizations API version: 1.0.0 extends: openapi/edge-impulse-organizations-api-openapi.yml actions: - target: $.info update: x-apievangelist-phrasing: method: generated generated: '2026-10-01' generator: build-phrasing.py label: Generated by API Evangelist operations: 80 - target: $.paths['/api/organizations'].get update: x-apievangelist-phrasing: intent: List organizations I belong to effect: read questions: - Which Edge Impulse organizations am I a member of? - Why does an API key only show one organization when I list them? instructions: - text: List the organizations I'm part of. - text: Show every active organization my account can access. method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/create'].post update: x-apievangelist-phrasing: intent: Create a new organization effect: write questions: - How do I set up a brand-new organization for my team? - What do I need to provide to create an organization for myself? instructions: - text: Create a new organization named {organizationName}. slots: organizationName: requestBody.organizationName - text: Set up my own organization called {organizationName}. slots: organizationName: requestBody.organizationName method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}'].get update: x-apievangelist-phrasing: intent: Get an organization's details effect: read questions: - Where do I see all the information about my organization? - What details, like name, logo and members, does an organization record hold? instructions: - text: Get the details of organization {organizationId}. slots: organizationId: path.organizationId - text: Show everything about my organization {organizationId}. slots: organizationId: path.organizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}'].post update: x-apievangelist-phrasing: intent: Update my organization's settings effect: write questions: - How do I rename my organization or change its readme? - Can I set a monthly job compute limit on my own organization? instructions: - text: Rename my organization {organizationId} to {name}. slots: organizationId: path.organizationId name: requestBody.name - text: Update the readme of organization {organizationId} to {readme}. slots: organizationId: path.organizationId readme: requestBody.readme - text: Set the job limit of organization {organizationId} to {jobLimitM} minutes. slots: organizationId: path.organizationId jobLimitM: requestBody.jobLimitM method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}'].delete update: x-apievangelist-phrasing: intent: Permanently delete my organization effect: destructive questions: - Is deleting my organization and all its data reversible? - How do I remove my organization completely? instructions: - text: Delete my organization {organizationId} and all its data. slots: organizationId: path.organizationId - text: Irrevocably remove organization {organizationId}. slots: organizationId: path.organizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/trial/request-extension'].post update: x-apievangelist-phrasing: intent: Request an enterprise trial extension effect: write questions: - 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? instructions: - text: Request an enterprise trial extension for organization {organizationId} because {reason}. slots: organizationId: path.organizationId reason: requestBody.reason - text: Ask to extend trial {trialId} for organization {organizationId} with use case {useCase} and timeline {timeline}. slots: trialId: requestBody.trialId organizationId: path.organizationId useCase: requestBody.useCase timeline: requestBody.timeline method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/metrics'].get update: x-apievangelist-phrasing: intent: Get usage metrics for my organization effect: read questions: - What general usage metrics are available for my organization? - Can I exclude Edge Impulse staff from my organization's metrics? instructions: - text: Get general metrics for organization {organizationId}. slots: organizationId: path.organizationId - text: Show organization {organizationId} metrics only for {projectVisibility} projects. slots: organizationId: path.organizationId projectVisibility: query.projectVisibility method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/request-hr-block-license'].post update: x-apievangelist-phrasing: intent: Request a license for the HR block effect: write questions: - 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? instructions: - text: Request an HR block license for organization {organizationId}. slots: organizationId: path.organizationId - text: Ask for the heart-rate block deployment license on organization {organizationId}. slots: organizationId: path.organizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/limits-request'].post update: x-apievangelist-phrasing: intent: Request higher organization limits effect: write questions: - Can I ask for more users, projects, compute or storage for my organization? - Which organization limits can I request to raise? instructions: - text: Request an increase of {limits} for organization {organizationId}. slots: limits: requestBody.limits organizationId: path.organizationId - text: Ask to raise organization {organizationId} limits to {limits} because {reason}. slots: organizationId: path.organizationId limits: requestBody.limits reason: requestBody.reason method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel'].get update: x-apievangelist-phrasing: intent: Get white label configuration effect: read questions: - As a white label admin, where do I see my white label's configuration? - Which project types does my white label currently support? instructions: - text: Get the white label information for organization {organizationId}. slots: organizationId: path.organizationId - text: Show my white label settings via organization {organizationId}. slots: organizationId: path.organizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel'].put update: x-apievangelist-phrasing: intent: Update supported project types for a white label effect: write questions: - How do I change which project types users can create in my white label? - Can a white label admin restrict the supported project types? instructions: - text: Set the supported project types of the white label for organization {organizationId} to {supportedProjectTypes}. slots: organizationId: path.organizationId supportedProjectTypes: requestBody.supportedProjectTypes - text: Limit white label {organizationId} to project types {supportedProjectTypes}. slots: organizationId: path.organizationId supportedProjectTypes: requestBody.supportedProjectTypes method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/deploymentTargets'].post update: x-apievangelist-phrasing: intent: Choose enabled deployment targets for a white label effect: write questions: - 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? instructions: - text: Enable deployment targets {targets} for the white label of organization {organizationId}. slots: targets: requestBody.targets organizationId: path.organizationId - text: Update which deployment targets white label {organizationId} offers to {targets}. slots: organizationId: path.organizationId targets: requestBody.targets method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/deploymentTargets/default'].post update: x-apievangelist-phrasing: intent: Set the white label's default deployment target effect: write questions: - 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? instructions: - text: Make {defaultDeploymentTarget} the default deployment target for white label {organizationId}. slots: defaultDeploymentTarget: requestBody.defaultDeploymentTarget organizationId: path.organizationId - text: Change the white label default target of organization {organizationId} to {defaultDeploymentTarget}. slots: organizationId: path.organizationId defaultDeploymentTarget: requestBody.defaultDeploymentTarget method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/deploymentOptionsOrder'].post update: x-apievangelist-phrasing: intent: Reorder deployment options in the white label effect: write questions: - 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? instructions: - text: Reorder the deployment options for white label {organizationId} as {order}. slots: organizationId: path.organizationId order: requestBody.order - text: Show deployment options in white label {organizationId} in the order {order}. slots: organizationId: path.organizationId order: requestBody.order method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/learningBlocks'].post update: x-apievangelist-phrasing: intent: Choose enabled learning blocks for a white label effect: write questions: - How do I limit which learning blocks are available in my white label? - Can a white label admin enable only certain learning blocks? instructions: - text: Enable learning blocks {learningBlocks} for white label {organizationId}. slots: learningBlocks: requestBody.learningBlocks organizationId: path.organizationId - text: Update the learning blocks white label {organizationId} offers to {learningBlocks}. slots: organizationId: path.organizationId learningBlocks: requestBody.learningBlocks method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/theme/logo'].post update: x-apievangelist-phrasing: intent: Update the white label theme logo effect: write questions: - How do I replace the main logo shown across my white label? - Can a white label admin upload a new theme logo? instructions: - text: Upload {image} as the white label theme logo for organization {organizationId}. slots: image: requestBody.image organizationId: path.organizationId - text: Replace the main white label logo of organization {organizationId}. slots: organizationId: path.organizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/theme/deviceLogo'].post update: x-apievangelist-phrasing: intent: Update the white label device logo effect: write questions: - 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? instructions: - text: Upload {image} as the white label device logo for organization {organizationId}. slots: image: requestBody.image organizationId: path.organizationId - text: Replace the device logo in white label {organizationId}'s theme. slots: organizationId: path.organizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/theme/colors'].post update: x-apievangelist-phrasing: intent: Update the white label theme colors effect: write questions: - How do I brand my white label with our primary color? - Can the white label theme use a gradient end color as well? instructions: - text: Set white label {organizationId} primary color to {primaryColor}. slots: organizationId: path.organizationId primaryColor: requestBody.primaryColor - text: Set the white label gradient end color for organization {organizationId} to {primaryColorGradientEnd}. slots: organizationId: path.organizationId primaryColorGradientEnd: requestBody.primaryColorGradientEnd method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/theme/favicon'].post update: x-apievangelist-phrasing: intent: Update the white label favicon effect: write questions: - How do I change the browser tab icon for my white label site? - Can a white label admin upload a custom favicon? instructions: - text: Upload {image} as the white label favicon for organization {organizationId}. slots: image: requestBody.image organizationId: path.organizationId - text: Replace white label {organizationId}'s tab icon with {image}. slots: organizationId: path.organizationId image: requestBody.image method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/metrics'].get update: x-apievangelist-phrasing: intent: Get global white label metrics effect: read questions: - What global usage metrics can I see across my whole white label? - How many users and projects does my white label have overall? instructions: - text: Get global metrics for the white label of organization {organizationId}. slots: organizationId: path.organizationId - text: Show white label-wide usage numbers for {organizationId}. slots: organizationId: path.organizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/users'].get update: x-apievangelist-phrasing: intent: List all users in a white label effect: read questions: - 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? instructions: - text: List all users registered in white label {organizationId}. slots: organizationId: path.organizationId - text: Search white label {organizationId} users for {search}, {limit} per page. slots: organizationId: path.organizationId search: query.search limit: query.limit - text: Show {tier} tier users in white label {organizationId}. slots: tier: query.tier organizationId: path.organizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/users/{userId}'].get update: x-apievangelist-phrasing: intent: Get a white label user's profile effect: read questions: - 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? instructions: - text: Get white label user {userId} in organization {organizationId}. slots: userId: path.userId organizationId: path.organizationId - text: Show the account of white label user {userId}. slots: userId: path.userId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/users/{userId}'].post update: x-apievangelist-phrasing: intent: Update a white label user effect: write questions: - 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? instructions: - text: Suspend white label user {userId} in organization {organizationId} by setting suspended to {suspended}. slots: userId: path.userId organizationId: path.organizationId suspended: requestBody.suspended - text: Change white label user {userId}'s email to {email}. slots: userId: path.userId email: requestBody.email - text: Update the job title of white label user {userId} to {jobTitle}. slots: userId: path.userId jobTitle: requestBody.jobTitle method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/users/{userId}'].delete update: x-apievangelist-phrasing: intent: Delete a white label user effect: destructive questions: - How do I delete a user account from my white label? - Can a white label admin remove a user entirely? instructions: - text: Delete white label user {userId} from organization {organizationId}. slots: userId: path.userId organizationId: path.organizationId - text: Remove user account {userId} from the white label. slots: userId: path.userId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/users/{userId}/metrics'].get update: x-apievangelist-phrasing: intent: Get marketing metrics for a white label user effect: read questions: - What marketing metrics are tracked for an individual white label user? - How engaged is a particular user in my white label? instructions: - text: Get marketing metrics for white label user {userId} in organization {organizationId}. slots: userId: path.userId organizationId: path.organizationId - text: Show engagement metrics of white label user {userId}. slots: userId: path.userId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/users/{userId}/jobs'].get update: x-apievangelist-phrasing: intent: List a white label user's project jobs effect: read questions: - Which project jobs has a specific white label user run? - Can I page through all jobs started by one user in my white label? instructions: - text: List project jobs for white label user {userId} in organization {organizationId}. slots: userId: path.userId organizationId: path.organizationId - text: Show {limit} jobs run by white label user {userId}. slots: limit: query.limit userId: path.userId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/projects'].get update: x-apievangelist-phrasing: intent: List all projects in a white label effect: read questions: - How do I see every project created across my white label? - Can I search white label projects by name or show only active ones? instructions: - text: List all projects in white label {organizationId}. slots: organizationId: path.organizationId - text: Search white label {organizationId} projects for {search}. slots: organizationId: path.organizationId search: query.search method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/projects'].post update: x-apievangelist-phrasing: intent: Create a free-tier project in a white label effect: write questions: - 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? instructions: - text: Create white label project {projectName} in organization {organizationId}. slots: projectName: requestBody.projectName organizationId: path.organizationId - text: Create a free-tier white label project {projectName} owned by {ownerEmail}. slots: projectName: requestBody.projectName ownerEmail: requestBody.ownerEmail method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/projects/{projectId}'].get update: x-apievangelist-phrasing: intent: Get a white label project's details effect: read questions: - How does a white label admin inspect any project in the white label? - What project information can I read as a white label admin? instructions: - text: Get white label project {projectId} in organization {organizationId}. slots: projectId: path.projectId organizationId: path.organizationId - text: Show the details of white label project {projectId}. slots: projectId: path.projectId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/projects/{projectId}'].post update: x-apievangelist-phrasing: intent: Update a white label project's settings effect: write questions: - 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? - Is it possible to change a project's training job RAM from the white label admin side? instructions: - text: Set the compute time limit of white label project {projectId} in organization {organizationId} to {computeTimeLimitM} minutes. slots: projectId: path.projectId organizationId: path.organizationId computeTimeLimitM: requestBody.computeTimeLimitM - text: Rename white label project {projectId} to {name}. slots: projectId: path.projectId name: requestBody.name - text: Turn GPU training to {useGpu} on white label project {projectId}. slots: useGpu: requestBody.useGpu projectId: path.projectId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/projects/{projectId}'].delete update: x-apievangelist-phrasing: intent: Delete a white label project effect: destructive questions: - How does a white label admin delete someone's project? - Can I remove a project from my white label entirely? instructions: - text: Delete white label project {projectId} in organization {organizationId}. slots: projectId: path.projectId organizationId: path.organizationId - text: Remove project {projectId} from the white label. slots: projectId: path.projectId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/projects/{projectId}/apiKeys'].post update: x-apievangelist-phrasing: intent: Add a temporary API key to a white label project effect: write questions: - 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? instructions: - text: Add API key {name} to white label project {projectId} in organization {organizationId}. slots: name: requestBody.name projectId: path.projectId organizationId: path.organizationId - text: Create a temporary project API key {name} for project {projectId} expiring after {ttl} seconds. slots: name: requestBody.name projectId: path.projectId ttl: requestBody.ttl method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members'].post update: x-apievangelist-phrasing: intent: Add a user to a white label project effect: write questions: - 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? instructions: - text: Add {usernameOrEmail} to white label project {projectId} in organization {organizationId}. slots: usernameOrEmail: requestBody.usernameOrEmail projectId: path.projectId organizationId: path.organizationId - text: Add myself to white label project {projectId}. slots: projectId: path.projectId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members/{userId}'].delete update: x-apievangelist-phrasing: intent: Remove a user from a white label project effect: destructive questions: - How do I take a user off a project as a white label admin? - Can a white label admin revoke someone's project membership? instructions: - text: Remove user {userId} from white label project {projectId} in organization {organizationId}. slots: userId: path.userId projectId: path.projectId organizationId: path.organizationId - text: Revoke user {userId}'s membership of project {projectId} in the white label. slots: userId: path.userId projectId: path.projectId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/projects/{projectId}/jobs'].get update: x-apievangelist-phrasing: intent: List jobs for a white label project effect: read questions: - What jobs have run in a given project across my white label? - Can a white label admin page through a project's job history? instructions: - text: Show the job history of project {projectId}, as white label admin of {organizationId}. slots: projectId: path.projectId organizationId: path.organizationId - text: Show the last {limit} jobs of white label project {projectId}. slots: limit: query.limit projectId: path.projectId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/development-boards'].post update: x-apievangelist-phrasing: intent: Add a development board to a white label effect: write questions: - 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? instructions: - text: Add development board {name} with image {image} and docs {docsUrl} to white label {organizationId}. slots: name: requestBody.name image: requestBody.image docsUrl: requestBody.docsUrl organizationId: path.organizationId - text: Register board {name} in the white label, documented at {docsUrl}, with image {image}. slots: name: requestBody.name docsUrl: requestBody.docsUrl image: requestBody.image method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}'].put update: x-apievangelist-phrasing: intent: Update a white label development board effect: write questions: - 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? instructions: - text: Rename development board {developmentBoardId} in white label {organizationId} to {name}. slots: developmentBoardId: path.developmentBoardId organizationId: path.organizationId name: requestBody.name - text: Change the docs link of development board {developmentBoardId} to {docsUrl}. slots: developmentBoardId: path.developmentBoardId docsUrl: requestBody.docsUrl method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}'].delete update: x-apievangelist-phrasing: intent: Remove a development board from a white label effect: destructive questions: - 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? instructions: - text: Remove development board {developmentBoardId} from white label {organizationId}. slots: developmentBoardId: path.developmentBoardId organizationId: path.organizationId - text: Delete board {developmentBoardId} from the white label list. slots: developmentBoardId: path.developmentBoardId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}/image'].post update: x-apievangelist-phrasing: intent: Update a development board's image effect: write questions: - 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? instructions: - text: Upload {image} as the picture for development board {developmentBoardId} in white label {organizationId}. slots: image: requestBody.image developmentBoardId: path.developmentBoardId organizationId: path.organizationId - text: Replace the photo of board {developmentBoardId}. slots: developmentBoardId: path.developmentBoardId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations'].get update: x-apievangelist-phrasing: intent: List all organizations in a white label effect: read questions: - How do I see every organization inside my white label? - Can I include deleted organizations when listing the white label's orgs? instructions: - text: List all organizations in white label {organizationId}. slots: organizationId: path.organizationId - text: Search organizations in white label {organizationId} for {search}, including deleted ones. slots: organizationId: path.organizationId search: query.search method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations'].post update: x-apievangelist-phrasing: intent: Create an organization inside a white label effect: write questions: - 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? instructions: - text: Create organization {organizationName} inside white label {organizationId}. slots: organizationName: requestBody.organizationName organizationId: path.organizationId - text: Create white label organization {organizationName} with {adminEmail} as its admin. slots: organizationName: requestBody.organizationName adminEmail: requestBody.adminEmail method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/computeTime'].get update: x-apievangelist-phrasing: intent: Get an organization's compute time usage effect: read questions: - How much compute time did a customer organization use over a date range? - Can a white label admin check compute usage between two dates? instructions: - text: Get compute time usage for organization {innerOrganizationId} in white label {organizationId} from {startDate} to {endDate}. slots: innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId startDate: query.startDate endDate: query.endDate - text: Show compute minutes used by organization {innerOrganizationId} between {startDate} and {endDate}. slots: innerOrganizationId: path.innerOrganizationId startDate: query.startDate endDate: query.endDate method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports'].get update: x-apievangelist-phrasing: intent: List an organization's usage reports effect: read questions: - Which usage reports already exist for a customer organization? - Can I page through generated usage reports as a white label admin? instructions: - text: List usage reports for organization {innerOrganizationId} in white label {organizationId}. slots: innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId - text: Show {limit} usage reports for organization {innerOrganizationId}. slots: limit: query.limit innerOrganizationId: path.innerOrganizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports'].post update: x-apievangelist-phrasing: intent: Generate a usage report for an organization effect: write questions: - How do I generate a usage report for a customer organization over a period? - Does creating a usage report run as a background job? instructions: - text: Generate a usage report for organization {innerOrganizationId} in white label {organizationId} from {startDate} to {endDate}. slots: innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId startDate: query.startDate endDate: query.endDate - text: Start a usage report job for organization {innerOrganizationId} covering {startDate} through {endDate}. slots: innerOrganizationId: path.innerOrganizationId startDate: query.startDate endDate: query.endDate method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}'].get update: x-apievangelist-phrasing: intent: Get a usage report's details effect: read questions: - Is my requested usage report ready yet, and what period does it cover? - How do I look up a single usage report by ID? instructions: - text: Get usage report {reportId} for organization {innerOrganizationId} in white label {organizationId}. slots: reportId: path.reportId innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId - text: Check the status of usage report {reportId}. slots: reportId: path.reportId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}'].delete update: x-apievangelist-phrasing: intent: Delete a usage report effect: destructive questions: - Can I delete an old usage report for a customer organization? - How do I remove a usage report I generated by mistake? instructions: - text: Delete usage report {reportId} for organization {innerOrganizationId} in white label {organizationId}. slots: reportId: path.reportId innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId - text: Remove usage report {reportId}. slots: reportId: path.reportId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}/download'].get update: x-apievangelist-phrasing: intent: Download a usage report effect: read questions: - How do I download the file for a finished usage report? - Can I save a customer organization's usage report locally? instructions: - text: Download usage report {reportId} for organization {innerOrganizationId} in white label {organizationId}. slots: reportId: path.reportId innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId - text: Save the file of usage report {reportId}. slots: reportId: path.reportId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports'].get update: x-apievangelist-phrasing: intent: List a customer organization's data exports effect: read questions: - 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? instructions: - text: List data exports for organization {innerOrganizationId} in white label {organizationId}. slots: innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId - text: Show {limit} white label data exports for organization {innerOrganizationId}. slots: limit: query.limit innerOrganizationId: path.innerOrganizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports'].post update: x-apievangelist-phrasing: intent: Create a data export for an organization effect: write questions: - 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? instructions: - text: Create a data export described as {description} for organization {innerOrganizationId} in white label {organizationId}. slots: description: requestBody.description innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId - text: Export organization {innerOrganizationId}'s data as {description}, expiring on {expirationDate}. slots: innerOrganizationId: path.innerOrganizationId description: requestBody.description expirationDate: requestBody.expirationDate method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}'].get update: x-apievangelist-phrasing: intent: Get a customer organization's data export effect: read questions: - 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? instructions: - text: Get data export {exportId} for organization {innerOrganizationId} in white label {organizationId}. slots: exportId: path.exportId innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId - text: Check white label export {exportId} of organization {innerOrganizationId}. slots: exportId: path.exportId innerOrganizationId: path.innerOrganizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}'].put update: x-apievangelist-phrasing: intent: Update a data export's description or expiry effect: write questions: - Can I extend the expiration date of an organization data export? - How do I change the description of an existing export? instructions: - text: Set the expiration of export {exportId} for organization {innerOrganizationId} in white label {organizationId} to {expirationDate}. slots: exportId: path.exportId innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId expirationDate: requestBody.expirationDate - text: Change the description of export {exportId} to {description}. slots: exportId: path.exportId description: requestBody.description method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}'].delete update: x-apievangelist-phrasing: intent: Delete an organization data export effect: destructive questions: - How do I delete a data export I made for a customer organization? - Can a white label admin remove an export before it expires? instructions: - text: Delete data export {exportId} for organization {innerOrganizationId} in white label {organizationId}. slots: exportId: path.exportId innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId - text: Remove white label export {exportId} now. slots: exportId: path.exportId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/apiKeys'].post update: x-apievangelist-phrasing: intent: Add a temporary API key to an organization effect: write questions: - 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? instructions: - text: Add a temporary API key to organization {innerOrganizationId} in white label {organizationId}. slots: innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId - text: Create an organization API key for {innerOrganizationId} that expires after {ttl} seconds. slots: innerOrganizationId: path.innerOrganizationId ttl: requestBody.ttl method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/members'].post update: x-apievangelist-phrasing: intent: Add a user to a white label organization effect: write questions: - 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? instructions: - text: Add {usernameOrEmail} to organization {innerOrganizationId} in white label {organizationId} as {role} with datasets {datasets}. slots: usernameOrEmail: requestBody.usernameOrEmail innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId role: requestBody.role datasets: requestBody.datasets - text: Add myself to white label organization {innerOrganizationId} as {role} with access to {datasets}. slots: innerOrganizationId: path.innerOrganizationId role: requestBody.role datasets: requestBody.datasets method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/members/{userId}'].delete update: x-apievangelist-phrasing: intent: Remove a user from a white label organization effect: destructive questions: - 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? instructions: - text: As white label admin of {organizationId}, kick user {userId} out of customer organization {innerOrganizationId}. slots: userId: path.userId innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId - text: Revoke user {userId}'s membership in white label organization {innerOrganizationId}. slots: userId: path.userId innerOrganizationId: path.innerOrganizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}'].get update: x-apievangelist-phrasing: intent: Get a white label organization's details effect: read questions: - 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? instructions: - text: Get the details of organization {innerOrganizationId} in white label {organizationId}. slots: innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId - text: Show white label organization {innerOrganizationId}, including if deleted. slots: innerOrganizationId: path.innerOrganizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}'].post update: x-apievangelist-phrasing: intent: Update a white label organization's settings effect: write questions: - 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? instructions: - text: Set entitlement limits of organization {innerOrganizationId} in white label {organizationId} to {entitlementLimits}. slots: innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId entitlementLimits: requestBody.entitlementLimits - text: Set the contract start date of white label organization {innerOrganizationId} to {contractStartDate}. slots: innerOrganizationId: path.innerOrganizationId contractStartDate: requestBody.contractStartDate - text: Mark white label organization {innerOrganizationId} billable as {billable}. slots: innerOrganizationId: path.innerOrganizationId billable: requestBody.billable method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}'].delete update: x-apievangelist-phrasing: intent: Delete an organization from a white label effect: destructive questions: - How does a white label admin delete a customer organization? - Can a deleted white label organization be brought back later? instructions: - text: Delete organization {innerOrganizationId} from white label {organizationId}. slots: innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId - text: Remove customer organization {innerOrganizationId} from the white label. slots: innerOrganizationId: path.innerOrganizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/restore'].get update: x-apievangelist-phrasing: intent: Restore a deleted organization effect: write questions: - 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? instructions: - text: Restore deleted organization {innerOrganizationId} in white label {organizationId}. slots: innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId - text: Undelete organization {innerOrganizationId} and its projects. slots: innerOrganizationId: path.innerOrganizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/projects'].post update: x-apievangelist-phrasing: intent: Create a project for a white label organization effect: write questions: - 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? instructions: - text: Inside customer organization {innerOrganizationId} (white label {organizationId}), set up a new project called {projectName}. slots: projectName: requestBody.projectName innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId - text: Create a {projectVisibility} project {projectName} for white label organization {innerOrganizationId} owned by {ownerEmail}. slots: projectVisibility: requestBody.projectVisibility projectName: requestBody.projectName innerOrganizationId: path.innerOrganizationId ownerEmail: requestBody.ownerEmail method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/jobs'].get update: x-apievangelist-phrasing: intent: List jobs for a white label organization effect: read questions: - 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? instructions: - text: Show every job run by customer organization {innerOrganizationId}, viewed from white label {organizationId}. slots: innerOrganizationId: path.innerOrganizationId organizationId: path.organizationId - text: Show the latest {limit} jobs of white label organization {innerOrganizationId}. slots: limit: query.limit innerOrganizationId: path.innerOrganizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/logo'].post update: x-apievangelist-phrasing: intent: Upload my organization's logo effect: write questions: - How do I upload a logo for my organization? - Can I replace the organization logo with a new image file? instructions: - text: Upload {image} as the logo of organization {organizationId}. slots: image: requestBody.image organizationId: path.organizationId - text: Replace my organization {organizationId} logo. slots: organizationId: path.organizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/header'].post update: x-apievangelist-phrasing: intent: Upload my organization's header image effect: write questions: - How do I set a banner header image on my organization page? - Can I upload a new organization header without touching the logo? instructions: - text: Upload {image} as the header image of organization {organizationId}. slots: image: requestBody.image organizationId: path.organizationId - text: Replace the banner on organization {organizationId}'s page. slots: organizationId: path.organizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/test-admin'].get update: x-apievangelist-phrasing: intent: Check admin access to an organization effect: read questions: - 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? instructions: - text: Test whether I have admin rights on organization {organizationId}. slots: organizationId: path.organizationId - text: Call the admin test endpoint for organization {organizationId}. slots: organizationId: path.organizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/projects'].get update: x-apievangelist-phrasing: intent: List my organization's projects effect: read questions: - Which projects belong to my organization? - Can I get every project my organization owns in one call? instructions: - text: List all projects of organization {organizationId}. slots: organizationId: path.organizationId - text: Show the projects owned by my organization {organizationId}. slots: organizationId: path.organizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/apikeys'].get update: x-apievangelist-phrasing: intent: List my organization's API keys effect: read questions: - What API keys exist for my organization? - Why do organization API keys only show part of the key when listed? instructions: - text: List the API keys of organization {organizationId}. slots: organizationId: path.organizationId - text: Show the masked API keys for my organization {organizationId}. slots: organizationId: path.organizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/apikeys'].post update: x-apievangelist-phrasing: intent: Add an API key to my organization effect: write questions: - 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? instructions: - text: Add API key {name} with role {role} to organization {organizationId}. slots: name: requestBody.name role: requestBody.role organizationId: path.organizationId - text: Create organization API key {name} as {role} using the value {apiKey}. slots: name: requestBody.name role: requestBody.role apiKey: requestBody.apiKey method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/apikeys/{apiKeyId}'].delete update: x-apievangelist-phrasing: intent: Revoke an organization API key effect: destructive questions: - How do I revoke a leaked organization API key? - Can I disable one organization key without affecting the others? instructions: - text: Revoke API key {apiKeyId} on organization {organizationId}. slots: apiKeyId: path.apiKeyId organizationId: path.organizationId - text: Disable organization key {apiKeyId} now. slots: apiKeyId: path.apiKeyId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/members/add'].post update: x-apievangelist-phrasing: intent: Add an existing user to my organization effect: write questions: - 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? instructions: - text: Add {usernameOrEmail} to organization {organizationId} as {role} with datasets {datasets}. slots: usernameOrEmail: requestBody.usernameOrEmail organizationId: path.organizationId role: requestBody.role datasets: requestBody.datasets - text: Make existing user {usernameOrEmail} a {role} in my organization with access to {datasets}. slots: usernameOrEmail: requestBody.usernameOrEmail role: requestBody.role datasets: requestBody.datasets method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/members/invite'].post update: x-apievangelist-phrasing: intent: Invite someone to my organization by email effect: write questions: - How do I email an invitation to join my organization? - Can I invite a colleague who doesn't have an account yet? instructions: - text: Invite {email} to organization {organizationId} as {role} with datasets {datasets}. slots: email: requestBody.email organizationId: path.organizationId role: requestBody.role datasets: requestBody.datasets - text: Send an organization invitation to {email} for role {role} covering {datasets}. slots: email: requestBody.email role: requestBody.role datasets: requestBody.datasets method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/members/remove'].post update: x-apievangelist-phrasing: intent: Remove a member from my organization effect: destructive questions: - How do I remove someone from my organization? - Why can't I remove the last remaining member of an organization? instructions: - text: Remove member {id} from organization {organizationId}. slots: id: requestBody.id organizationId: path.organizationId - text: Take member {id} out of my organization. slots: id: requestBody.id method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/members/{memberId}/role'].post update: x-apievangelist-phrasing: intent: Change a member's role in my organization effect: write questions: - How do I promote an organization member to admin? - Can I change a member from member to guest? instructions: - text: Set the role of member {memberId} in organization {organizationId} to {role}. slots: memberId: path.memberId organizationId: path.organizationId role: requestBody.role - text: Promote organization member {memberId} to {role}. slots: memberId: path.memberId role: requestBody.role method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/members/{memberId}/datasets'].post update: x-apievangelist-phrasing: intent: Set which datasets a guest member can access effect: write questions: - How do I restrict a guest member to specific datasets? - Can I change the datasets a guest in my organization can see? instructions: - text: Give guest member {memberId} of organization {organizationId} access to datasets {datasets}. slots: memberId: path.memberId organizationId: path.organizationId datasets: requestBody.datasets - text: Limit guest {memberId} to datasets {datasets}. slots: memberId: path.memberId datasets: requestBody.datasets method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/members/{memberId}/resend-invite'].post update: x-apievangelist-phrasing: intent: Resend an organization invitation effect: write questions: - A colleague lost their invite email; can I send it again? - How do I resend a pending organization invitation? instructions: - text: Resend the invitation to member {memberId} of organization {organizationId}. slots: memberId: path.memberId organizationId: path.organizationId - text: Send member {memberId} their organization invite again. slots: memberId: path.memberId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/readme/upload-image'].post update: x-apievangelist-phrasing: intent: Upload an image for the organization readme effect: write questions: - 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? instructions: - text: Upload {image} for the readme of organization {organizationId}. slots: image: requestBody.image organizationId: path.organizationId - text: Host readme image {image} on the CDN and give me its path. slots: image: requestBody.image method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/exports'].get update: x-apievangelist-phrasing: intent: List my organization's data exports effect: read questions: - Which data exports has my own organization created? - Can I page through my organization's exports? instructions: - text: List data exports for my organization {organizationId}. slots: organizationId: path.organizationId - text: Show {limit} of my organization {organizationId}'s exports. slots: limit: query.limit organizationId: path.organizationId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/exports/{exportId}'].get update: x-apievangelist-phrasing: intent: Get one of my organization's data exports effect: read questions: - Is my organization's data export ready to download yet? - How do I check the details of one of my own organization's exports? instructions: - text: Get data export {exportId} of my organization {organizationId}. slots: exportId: path.exportId organizationId: path.organizationId - text: Check whether my export {exportId} has finished. slots: exportId: path.exportId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/exports/{exportId}/download'].get update: x-apievangelist-phrasing: intent: Download my organization's data export effect: read questions: - How do I download the files of a finished organization data export? - Can I save my organization's exported data locally? instructions: - text: Download data export {exportId} from my organization {organizationId}. slots: exportId: path.exportId organizationId: path.organizationId - text: Save the contents of my organization export {exportId}. slots: exportId: path.exportId method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/multi-project-deployment/start'].post update: x-apievangelist-phrasing: intent: Build a deployment combining several projects' impulses effect: write questions: - Can I bundle impulses from multiple projects into one deployment? - Which inference engine is used when building a multi-project deployment? instructions: - text: Create a multi-project deployment in organization {organizationId} for impulses {impulses} using engine {engine}. slots: organizationId: path.organizationId impulses: requestBody.impulses engine: requestBody.engine - text: Combine impulses {impulses} into one {engine} build. slots: impulses: requestBody.impulses engine: requestBody.engine method: generated generated: '2026-10-01' - target: $.paths['/api/organizations/{organizationId}/multi-project-deployment/jobs/{jobId}/download'].get update: x-apievangelist-phrasing: intent: Download a multi-project deployment build effect: read questions: - 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? instructions: - text: Download multi-project deployment job {jobId} from organization {organizationId}. slots: jobId: path.jobId organizationId: path.organizationId - text: Get the combined deployment built by job {jobId}. slots: jobId: path.jobId method: generated generated: '2026-10-01'