For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Trust CenterStatusSupportGet a demoPlatform
DocumentationEvals API ReferenceIntegrations & OTELPlatform SettingsSelf-HostingGuidesChangelog
DocumentationEvals API ReferenceIntegrations & OTELPlatform SettingsSelf-HostingGuidesChangelog
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
    • Data Models
    • API Conventions
  • Data Models
      • GETList Projects
      • POSTCreate Project
      • GETRetrieve Project
      • PUTUpdate Project
      • DELDelete Project
        • GETList Project Invitations
        • POSTCreate Project Invitations
        • PUTResend Project Invitation
        • DELRevoke Project Invitation
  • Evals
  • Legacy
LogoLogo
Trust CenterStatusSupportGet a demoPlatform
Data ModelsProjectsInvitations

Create Project Invitations

POST
https://api.confident-ai.com/v1/projects/:projectId/invitations
POST
/v1/projects/:projectId/invitations
$curl -X POST https://api.confident-ai.com/v1/projects/projectId/invitations \
> -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>" \
> -H "Content-Type: application/json" \
> -d '{
> "emails": [
> "carol@example.com",
> "dave@example.com"
> ],
> "projectRoleId": "project-role-uuid-2"
>}'
200Successful
1{
2 "success": true,
3 "data": {
4 "invitations": [
5 {
6 "id": 201,
7 "email": "carol@example.com",
8 "status": "PENDING",
9 "created_at": "2024-12-04T23:00:00.000Z",
10 "projectRoleId": "project-role-uuid-2"
11 },
12 {
13 "id": 202,
14 "email": "dave@example.com",
15 "status": "PENDING",
16 "created_at": "2024-12-04T23:00:00.000Z",
17 "projectRoleId": "project-role-uuid-2"
18 }
19 ]
20 }
21}

Invites one or more users to a project by email. Emails that are already members or already invited are skipped. Optionally assign a project role to the invitees — the Owner role cannot be assigned. Inviting members is not available on the Free plan outside of the trial period.

Was this page helpful?
Previous

Resend Project Invitation

Next
Built with

Path parameters

projectIdstringRequired
The unique identifier of the project.

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Request

This endpoint expects an object.
emailslist of stringsRequired
One or more email addresses to invite
projectRoleIdstringOptionalformat: "uuid"

Optional project role id to assign to all invitees. The Owner role cannot be assigned.

Response

successboolean
Indicates if the request was successful
dataobject