Pinecone TypeScript SDK - v9.0.0
    Preparing search index...

    Class InvitesResource

    Invites let people join an organization with assigned roles. Access this resource through AdminClient.invites; do not construct it directly. Use AdminClient.users to manage existing members.

    import { AdminClient } from '@pinecone-database/pinecone';

    const admin = new AdminClient();
    const result = await admin.invites.list();
    Index
    constructor
    create delete describe list resend

    • Creates and sends an invitation to join the organization.

      Parameters

      • options: CreateInviteRequest

        The recipient email and roles to grant. Include an organization-scoped membership role.

      Returns Promise<Invite>

      The invite details, including its id and assigned roles.

      Errors.PineconeArgumentError when the email is empty or no role binding is provided.

      import { AdminClient } from '@pinecone-database/pinecone';

      const admin = new AdminClient();
      const invite = await admin.invites.create({
        email: 'alex@example.com',
        roleBindings: [{ resourceType: 'organization', role: 'OrgMember' }],
      });
      console.log(invite.id);

    • Deletes an invite.

      Parameters

      • inviteId: string

        The ID of the invite to delete.

      Returns Promise<void>

      Resolves when the deletion request succeeds.

      Errors.PineconeArgumentError when inviteId is empty.

      import { AdminClient } from '@pinecone-database/pinecone';

      const admin = new AdminClient();
      await admin.invites.delete('648ad735-cf52-4cf4-9949-47c56fd9731f');

    • Retrieves a invite by ID.

      Parameters

      • inviteId: string

        The invite ID returned when it was created or listed.

      Returns Promise<Invite>

      The invite details.

      Errors.PineconeArgumentError when inviteId is empty.

      import { AdminClient } from '@pinecone-database/pinecone';

      const admin = new AdminClient();
      const result = await admin.invites.describe('648ad735-cf52-4cf4-9949-47c56fd9731f');
      console.log(result);

    • Lists one page of invites in the organization.

      Parameters

      • options: ListInvitesOptions = {}

        Page size and continuation token. Omit to fetch the first page with the default size.

      Returns Promise<InviteList>

      Results in data; pass pagination.next as paginationToken to fetch the next page.

      import { AdminClient } from '@pinecone-database/pinecone';

      const admin = new AdminClient();
      const result = await admin.invites.list({ limit: 10 });
      console.log(result.data);

    • Resends an invitation and extends its expiration.

      Parameters

      • inviteId: string

        The ID of the existing invite to resend.

      Returns Promise<Invite>

      The updated invite details.

      Errors.PineconeArgumentError when the invite ID is empty.

      import { AdminClient } from '@pinecone-database/pinecone';

      const admin = new AdminClient();
      const invite = await admin.invites.resend('648ad735-cf52-4cf4-9949-47c56fd9731f');
      console.log(invite);

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods