v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB

Invitation

Send Invitation

Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.

post/api/invitation

Headers

TR-Organizationstring uuid required

The organization id to use for the request

Request body

app_urlstring required

The url of the app that the user will be directed to in order to set their password. Usually admin.trieve.ai, but may differ for local dev or self-hosted setups.

emailstring required

The email of the user to invite. Must be a valid email as they will be sent an email to register.

redirect_uristring required

The url that the user will be redirected to after setting their password.

scopesstring[] nullable

The api route scopes the user will have in the organization.

user_roleinteger required

The role the user will have in the organization. 0 = User, 1 = Admin, 2 = Owner.

Response

Ok response. Indicates that invitation email was sent correctly.