Add Pivot to your AI agent

Create a custom role in a Pivot space with an explicit set of permissions. Pivot does not document an endpoint for deleting space roles, so create only roles that may safely remain in the space.

Create a goal directly under an existing Pivot goal. Requires edit access to the parent and uses request_id as an idempotency key scoped to the caller and parent.

Create a Pivot webhook for an organization and return its one-time signing secret. Store the secret securely because it is not returned by later reads.

Delete a response from a Pivot block by its response UUID.

Delete a file attached to a block response by attachment UUID.

Delete a sharing rule from a Pivot block by sharing-rule UUID.

Permanently delete a Pivot label by its label UUID. Pivot returned HTTP 500 without deleting the build account's test label, so treat a provider error as no deletion and verify the label is absent after success.

Delete a sent Pivot room message. Provide sent_at for a non-thread message or thread_root_message_id for a message in a thread.

Permanently delete a Pivot space or template using its ordinary space lifecycle.

Permanently delete a Pivot user account, not merely remove a space membership. Pivot allows this only when the user's email is verified by the specified organization and by no other organization. This cannot be undone and deletes the user across all organizations.

Delete a Pivot user globally when the specified organization verified that user. Otherwise, remove the user's memberships only from the specified organization. This is destructive: the same call can permanently delete the user across Pivot, and user_deleted reports which outcome occurred.

Permanently delete a Pivot webhook by its webhook UUID.

Return a block by ID, optionally including all visible descendant blocks.

Return a Pivot room by its ID.

Retrieve one Pivot room message by its ID and send timestamp. Thread replies also require both thread locator IDs, and recording comments require the parent recording ID.

Return a specific Pivot room recording by ID, including transcript, chapter, summary, and caption assets.

Return a Pivot space by ID with its settings, roles, member summaries, and labels. Response-only access tokens are removed. The direct endpoint's member_count can be 0 even when members exist; use list spaces or list space members when an authoritative count is required.

Get the status of an asynchronous Pivot space copy or template application. Poll until status is succeeded or failed. For Copy Space, pass the source space_id used in the copy request; for Create Space from a template, pass the new space.id returned by Create Space.

Return a Pivot user's profile, space memberships, and groups within an organization. The response excludes the provider's presence token.

Hide an existing Pivot space from view. The Pivot API exposes no undo path for hiding a space.

Invite people to a Pivot room by email. A successful call creates room invitations and sends externally visible invitation emails to every address.

Invite people to a Pivot space by email. A successful call sends externally visible invitation emails to new users and adds existing Pivot users directly to the space with the specified roles and groups.

Return the responses attached to a Pivot block.

Return the sharing rules configured for a Pivot block.

Return the users in a specified Pivot group.

Return one page of groups in a Pivot organization.

Return the labels configured in a Pivot organization.

Return one page of users in a Pivot organization. Pass next_cursor from the preceding response unchanged to continue listing users.

Return one page of room messages, newest first. On the first call, provide the room ID and its created_at timestamp from Get Room. To continue through the current and older history windows, call again with only next_cursor; pagination stops automatically at the room's creation boundary.

Return one page of recordings for a Pivot room, including transcripts and other recording assets.

Return all assignment blocks in a Pivot space.

Return a space's description blocks and all of their descendants.

Return the blocks displayed on a Pivot space home.

Return one page of members in a Pivot space. By default, only active members are returned; use status to include other membership states.

Return the roles available in a Pivot space.

Return all room blocks and their parallel room metadata in a Pivot space.

Return one page of spaces visible in a Pivot organization. Supports exact status, type, template, label, name-search, and sort filters. Templates are excluded and only active spaces are returned unless those filters are set.

Return one page of messages in a Pivot thread, oldest first. Continue with next_cursor until has_more is false.

Return one page of delivery logs for a Pivot webhook. Pivot retains webhook logs for 30 days.

Return webhooks for a Pivot organization, optionally filtering by a case-insensitive substring of the webhook name.

Remove one or more users from a Pivot group.

Remove one label from a Pivot space by space and label UUID.

Remove a user from a Pivot space by space-member UUID.

Ensure a downloadable MP4 rendition exists for a Pivot room recording. When ready is false, the rendition is still being prepared; retry shortly with the same room_id, recording_id, and created_at. The direct download URL is returned when ready is true.

Revoke a Pivot organization invitation by its invitation ID and email address.

Revoke a Pivot room invitation by room ID and email address.

Revoke a Pivot space invitation by organization, space, and email address.

Rotate the organization-wide webhook signing secret used for future Pivot webhooks. Existing webhooks retain the current secret. Store the returned one-time secret securely.

Send plain text or an advanced rich-content document to a Pivot room, optionally with file attachments or as a thread, inline, or recording reply. Sending delivers the message to room participants and cannot be safely reversed.

Irreversibly submit a Pivot block response. This sends or marks an existing draft response as submitted and cannot be safely undone.

Update exactly one property of a Pivot block: its hide time, unhide time, or space-member sharing level.

Replace a Pivot block response with plain text, or use advanced rich content for formatting.

Set the access level for a user, group, space role, membership tier, or space identified by the subject of a sharing rule on a Pivot block.

Update the name, color, or both for a Pivot label. Pivot clears the existing color when a name update omits color, so resend the current color to preserve it.

Update one or more settings for a Pivot room, including its name, topic, type, and recording preferences.

Replace a sent Pivot room message with plain text or an advanced rich-content document. sent_at identifies the original message; include thread_root_message_id and thread_parent_message_id for a threaded message, or parent_recording_id for a recording comment.

Update one or more settings or metadata fields for an existing Pivot space. Only provided fields are changed.

Update a Pivot space member's roles, title, status, or any combination of those fields. The member ID is the space-membership UUID, not a user UUID.

Update one or more properties of a Pivot webhook. Supplying subscriptions replaces the webhook's complete existing subscription set.