Skip to main content
POST
/
admin
/
users
/
invites
from portkey_ai import Portkey

# Initialize the Portkey client
portkey = Portkey(
    api_key="PORTKEY_API_KEY",
)

# Add a user invite
user = portkey.admin.users.invites.create(
    email="user@example.com",
    role="member",
    workspaces=[
        {
            "id": "WORKSPACE_SLUG",
            "role": "admin"
        }
    ],
    workspace_api_key_details={
        "scopes": [
            "workspaces.list",
            "logs.export",
            "logs.list",
            "logs.view",
        ]
    }
)

print(user)
{
  "id": "a286286b-633d-4c4f-bddb-86b84a50a25c",
  "invite_link": "https://app.portkey.ai/invite_id"
}

Authorizations

​
x-portkey-api-key
string
header
required

Body

application/json
​
email
string
required
​
workspaces
object[]
required
​
role
enum<string>
required
Available options:
admin,
member
​
workspace_api_key_details
object

Response

200 - application/json

OK

​
id
string
required
​
invite_link
string
required