/

Docs
History
Schema
Generate

Filter operations

post/v1/ai/completeComplete sends the messages of a chat to the AI and asks it to generate a new message.
post/v1/billing/metrics-project-credentialsGetBillingProjectCredentials returns credentials for the configured cloud metrics project filtered by request organization
get/v1/billing/plansListPublicBillingPlans lists all public billing plans
post/v1/deployments/-/connector-oauth-tokenGetConnectorOAuthToken returns a user's OAuth access token for a connector in the calling deployment's project, refreshing it first if it is about to expire. It returns NotFound if the user has not authorized the connector's current OAuth configuration. It can only be called by deployments.
post/v1/deployments/-/connector-oauth-token/deleteDeleteConnectorOAuthToken removes a user's OAuth authorization for a connector in the calling deployment's project. It can only be called by deployments.
delete/v1/deployments/{deploymentId}DeleteDeployment deletes a deployment.
get/v1/deployments/{deploymentId}/configGetDeploymentConfig returns the configuration for a deployment that the runtime should apply. This is called by the runtime to pull its Variables and Annotations from the admin service.
post/v1/deployments/{deploymentId}/credentialsGetDeployment returns runtime info and access token on behalf of a specific user, or alternatively for a raw set of JWT attributes
post/v1/deployments/{deploymentId}/provisionProvision provisions a new resource for a deployment. If an existing resource matches the request, it will be returned without provisioning a new resource.
post/v1/deployments/{deploymentId}/reconcileTriggerReconcile triggers reconcile for the project's prod deployment. DEPRECATED: Clients should call CreateTrigger directly on the deployed runtime instead.
post/v1/deployments/{deploymentId}/refreshTriggerRefreshSources refresh the source for production deployment. DEPRECATED: Clients should call CreateTrigger directly on the deployed runtime instead.
post/v1/deployments/{deploymentId}/startStartDeployment starts a deployment.
post/v1/deployments/{deploymentId}/stopStopDeployment stops a deployment.
get/v1/github/repositoriesGetGithubRepoRequest returns info about a Github repo based on the caller's installations. If the caller has not granted access to the repository, instructions for granting access are returned.
get/v1/github/userGetGithubUserStatus returns info about a Github user account based on the caller's installations. If we don't have access to user's personal account tokens or it is expired, instructions for granting access are returned.
get/v1/github/user/repositories
delete/v1/magic-tokens/{tokenId}RevokeMagicAuthToken revokes a magic auth token.
get/v1/magic-tokens/currentGetCurrentMagicAuthToken returns information about the current magic auth token.
get/v1/organization-for-domain/{domain}GetOrganizationNameForDomain finds the org name for a custom domain. If the application detects it is running on a non-default domain, it can use this to find the org to present. It can be called without being authenticated.
get/v1/orgsListOrganizations lists all the organizations currently managed by the admin
post/v1/orgsCreateOrganization creates a new organization
get/v1/orgs/{org}GetOrganization returns information about a specific organization
delete/v1/orgs/{org}DeleteOrganization deletes an organization
patch/v1/orgs/{org}UpdateOrganization updates an organization
get/v1/orgs/{org}/billing/creditsGetBillingCreditBalance returns the organization's remaining trial credit balance
get/v1/orgs/{org}/billing/issuesListOrganizationBillingIssues lists all the billing issues for the organization
get/v1/orgs/{org}/billing/payments/portal-urlGetPaymentsPortalURL returns the URL for the billing session to collect payment method
get/v1/orgs/{org}/billing/subscriptionsGetBillingSubscription lists the subscription for the organization
delete/v1/orgs/{org}/billing/subscriptionsCancelBillingSubscription cancels the billing subscription for the organization
patch/v1/orgs/{org}/billing/subscriptionsUpdateBillingSubscription updates the billing plan for the organization
post/v1/orgs/{org}/billing/subscriptions/renewRenewBillingSubscription renews the billing plan for the organization once cancelled
put/v1/orgs/{org}/create-managed-git-repoCreateManagedGitRepo creates a new rill managed git repo for the organization.
post/v1/orgs/{org}/create_assetCreateAsset returns a one time signed URL using which any asset can be uploaded.
get/v1/orgs/{org}/invitesListOrganizationInvites lists all the org invites
get/v1/orgs/{org}/membersListOrganizationMemberUsers lists all the org members
post/v1/orgs/{org}/membersAddOrganizationMemberUser adds a user to the organization
get/v1/orgs/{org}/members/{email}GetOrganizationMemberUser gets the member details
put/v1/orgs/{org}/members/{email}SetOrganizationMemberUserRole sets the role for the member
delete/v1/orgs/{org}/members/{email}RemoveOrganizationMemberUser removes member from the organization
put/v1/orgs/{org}/members/{email}/attributesUpdateOrganizationMemberUserAttributes updates the attributes for a member
delete/v1/orgs/{org}/members/currentLeaveOrganization removes the current user from the organization
get/v1/orgs/{org}/projectsListProjectsForOrganization lists all the projects currently available for a given organization.
post/v1/orgs/{org}/projectsCreateProject creates a new project
get/v1/orgs/{org}/projects-for-userListProjectsForOrganizationAndUser lists all the projects that an organization member user has access to. It does not include projects that the user has access to through a usergroup.
get/v1/orgs/{org}/projects/{project}GetProject returns information about a specific project
delete/v1/orgs/{org}/projects/{project}DeleteProject deletes a project
patch/v1/orgs/{org}/projects/{project}UpdateProject updates a project
post/v1/orgs/{org}/projects/{project}/alertsCreateAlert adds a virtual file for an alert, triggers a reconcile, and waits for the alert to be added to the runtime catalog
post/v1/orgs/{org}/projects/{project}/alerts/-/yamlGenerateAlertYAML generates YAML for an alert to be copied into a project's Git repository
put/v1/orgs/{org}/projects/{project}/alerts/{name}EditAlert edits a virtual file for a UI-managed alert, triggers a reconcile, and waits for the alert to be updated in the runtime
delete/v1/orgs/{org}/projects/{project}/alerts/{name}DeleteAlert deletes the virtual file for a UI-managed alert, triggers a reconcile, and waits for the alert to be deleted in the runtime
post/v1/orgs/{org}/projects/{project}/alerts/{name}/unsubscribeUnsubscribeAlert removes the calling user from a alert's recipients list
get/v1/orgs/{org}/projects/{project}/alerts/{name}/yamlGenerateAlertYAML generates YAML for an alert to be copied into a project's Git repository
get/v1/orgs/{org}/projects/{project}/clone-credentialsGetCloneCredentials returns credentials and other details for a project's Git repository or archive path if git repo is not configured.
post/v1/orgs/{org}/projects/{project}/connect-to-githubConnects a rill managed project to github. Replaces the contents of the remote repo with the contents of the project.
post/v1/orgs/{org}/projects/{project}/credentialsGetDeploymentCredentials returns runtime info and access token on behalf of a specific user, or alternatively for a raw set of JWT attributes DEPRECATED: Clients should call GetDeployment instead.
get/v1/orgs/{org}/projects/{project}/deploymentsListDeployments lists deployments for a project.
post/v1/orgs/{org}/projects/{project}/deploymentsCreateDeployment creates a new deployment for a project.
get/v1/orgs/{org}/projects/{project}/embed-users/{id}GetEmbedUser returns an embed user, which is created when GetIFrame is called with an external user ID. It is used to show which external user owns a report created from an embed.
post/v1/orgs/{org}/projects/{project}/github/prCreateGithubPullRequest creates a Github PR from the specified branch in the project's connected Github repository to the primary branch.
get/v1/orgs/{org}/projects/{project}/github/pr/{branch}GetGithubPullRequest returns the status of the PR for the specified branch, if it exists.
post/v1/orgs/{org}/projects/{project}/hibernateHibernateProject hibernates a project by tearing down its deployments.
post/v1/orgs/{org}/projects/{project}/iframeGetIFrame returns the iframe URL for the given project
get/v1/orgs/{org}/projects/{project}/invitesListProjectInvites lists all the project invites
get/v1/orgs/{org}/projects/{project}/membersListProjectMemberUsers lists all the project members
post/v1/orgs/{org}/projects/{project}/membersAddProjectMemberUser adds a member to the project
get/v1/orgs/{org}/projects/{project}/members/{email}GetProjectMemberUser gets the member details
put/v1/orgs/{org}/projects/{project}/members/{email}SetProjectMemberUserRole sets the role for the member
delete/v1/orgs/{org}/projects/{project}/members/{email}RemoveProjectMemberUser removes member from the project
get/v1/orgs/{org}/projects/{project}/members/{email}/usergroupsListUsergroupsForProjectAndUser returns the user groups for a user within a project
get/v1/orgs/{org}/projects/{project}/personal-filesListPersonalFiles lists the calling user's personal files.
post/v1/orgs/{org}/projects/{project}/personal-filesCreatePersonalFile creates a personal (owner-only) resource as a virtual file in the project.
get/v1/orgs/{org}/projects/{project}/personal-files/{name}GetPersonalFile returns the YAML body and metadata for a personal virtual file the caller owns.
post/v1/orgs/{org}/projects/{project}/personal-files/{name}EditPersonalFile updates the YAML body of a personal virtual file the caller owns.
delete/v1/orgs/{org}/projects/{project}/personal-files/{name}DeletePersonalFile deletes a personal virtual file the caller owns.
post/v1/orgs/{org}/projects/{project}/redeployRedeployProject creates a new production deployment for a project. If the project currently has another production deployment, the old deployment will be deprovisioned. This RPC can be used to redeploy a project that has been hibernated.
post/v1/orgs/{org}/projects/{project}/reportsCreateReport adds a virtual file for a report, triggers a reconcile, and waits for the report to be added to the runtime catalog
post/v1/orgs/{org}/projects/{project}/reports/-/yamlGenerateReportYAML generates YAML for a scheduled report to be copied into a project's Git repository
put/v1/orgs/{org}/projects/{project}/reports/{name}EditReport edits a virtual file for a UI-managed report, triggers a reconcile, and waits for the report to be updated in the runtime
delete/v1/orgs/{org}/projects/{project}/reports/{name}DeleteReport deletes the virtual file for a UI-managed report, triggers a reconcile, and waits for the report to be deleted in the runtime
post/v1/orgs/{org}/projects/{project}/reports/{name}/triggerTriggerReport triggers an ad-hoc report run
post/v1/orgs/{org}/projects/{project}/reports/{name}/unsubscribeUnsubscribeReport removes the calling user from a reports recipients list
post/v1/orgs/{org}/projects/{project}/request-access
get/v1/orgs/{org}/projects/{project}/servicesListProjectMemberServices returns all the services for the project for an organization
delete/v1/orgs/{org}/projects/{project}/services/{name}RemoveProjectMemberService removes the service from the project
put/v1/orgs/{org}/projects/{project}/services/{name}/roleSetProjectMemberServiceRole updates the project role for the service
get/v1/orgs/{org}/projects/{project}/tokens/magicListMagicAuthTokens lists all the magic auth tokens for a specific project.
post/v1/orgs/{org}/projects/{project}/tokens/magicIssueMagicAuthToken creates a "magic" auth token that provides limited access to a specific filtered dashboard in a specific project.
get/v1/orgs/{org}/projects/{project}/usergroupsListProjectMemberUsergroups lists the user groups assigned to a project
put/v1/orgs/{org}/projects/{project}/usergroups/{usergroup}/rolesSetProjectMemberUsergroupRole sets the role for the user group
post/v1/orgs/{org}/projects/{project}/usergroups/{usergroup}/rolesAddProjectMemberUsergroup adds a user group to the project with a role
delete/v1/orgs/{org}/projects/{project}/usergroups/{usergroup}/rolesRemoveProjectMemberUsergroup revokes the project-level role for the user group
get/v1/orgs/{org}/projects/{project}/users/searchSearchProjectUsers returns users who has access to to a project (including org members that have access through a usergroup)
get/v1/orgs/{org}/projects/{project}/variablesGetProjectVariables returns project variables.
put/v1/orgs/{org}/projects/{project}/variablesUpdateProjectVariables updates variables for a project.
get/v1/orgs/{org}/projects/{project}/whitelistedListWhitelistedDomains lists all the whitelisted domains of the project
post/v1/orgs/{org}/projects/{project}/whitelistedCreateProjectWhitelistedDomain adds a domain to the project's whitelisted
delete/v1/orgs/{org}/projects/{project}/whitelisted/{domain}RemoveProjectWhitelistedDomain removes a domain from the project's whitelisted
get/v1/orgs/{org}/servicesListService returns all the services per organization
post/v1/orgs/{org}/servicesCreateService creates a new service per organization
get/v1/usersGetUser returns user by email

Changes to GetUser returns user by email

get/v1/users

Feb 3, 2026v179ebe0ca4add Revision changes
- info
  added the optional property / to the response with the status