Functions

create-invite

fn (request: InviteUserRequest): InviteUserResponse
fn (request: InviteUserRequest, opts: Map): InviteUserResponse

POST /organization/invites - Invite a user to the organization by email.

Example

admin {api-key: ::hot::ctx/get("openai.admin.key")}
invite ::openai::invite/create-invite(::openai::invite/InviteUserRequest({
  email: "ada@example.com",
  role: "reader"
}), admin)
invite.status

Types

Invite

Invite type {
    object: "organization.invite",
    id: Str,
    email: Str,
    role: OrganizationRole,
    status: InviteStatus,
    invited_at: Int,
    expires_at: Int?,
    accepted_at: Int?,
    projects: Vec<Map>?
}

InviteRequest

InviteRequest type {
    email: Str,
    role: "reader" | "owner",
    projects: Vec<Map>?
}

InviteStatus

InviteStatus type "accepted" | "expired" | "pending"

InviteUserRequest

InviteUserRequest type {
    email: Str,
    role: "reader" | "owner",
    projects: Vec<Map>?
}

InviteUserResponse

InviteUserResponse type {
    object: "organization.invite",
    id: Str,
    email: Str,
    role: OrganizationRole,
    status: InviteStatus,
    invited_at: Int,
    expires_at: Int?,
    accepted_at: Int?,
    projects: Vec<Map>?
}

OrganizationRole

OrganizationRole type "owner" | "reader"