attach-brand-to-segment-tool
ChatGPTAttach a brand to a segment. Idempotent: attaching a brand that is already attached succeeds without change. Both the brand and the segment must belong to the same project. Membership is what makes a brand a competitor, so attaching a discovered brand starts tracking it and attaching an ignored brand revives it, clearing its ignored mark. The own brand is implicit in every segment, so attaching it changes nothing.
attach-tag-to-prompt-tool
ChatGPTAttach a tag to a prompt. Idempotent: attaching a tag that is already attached succeeds without change. Both the prompt and the tag must belong to the same project.
create-brand-tool
ChatGPTCreate a brand in a project, ahead of Pineprompt discovering it from an AI response. Segment membership is what makes a brand a competitor, so pass segment_ids to start tracking it right away; without them the brand starts out discovered. When aliases are omitted, the brand is seeded with its display name. Display names are unique per project, case-insensitive, so a name that collides with an existing brand's display name or alias returns an error. To designate a brand as the project's own brand, pass its id as brand_id on the update-project tool instead.
create-invitation-tool
ChatGPTInvite a person to join an organization by email. This sends an invitation email to the given address, outside Pineprompt. Requires admin or owner rights in the organization. The recipient may accept it within 14 days. Allowed roles are admin and member; owner cannot be invited. Pending invitations count toward the organization's plan seat quota.
create-monitor-tool
ChatGPTActive prompts are sent daily to third-party AI search engines (for example ChatGPT, Gemini and Perplexity) on Pineprompt's schedule, which uses plan quota. Create a new monitor for a project. Each monitor runs prompts against one or more AI platforms in the given country and language. Subject to the organization's plan quota.
create-organization-tool
ChatGPTCreate a new organization with the authenticated user as the owner. The returned organization id may be used as organization_id in subsequent tool calls.
create-project-tool
ChatGPTCreate a new project in the given organization. Subject to the organization's plan quota.
create-prompt-tool
ChatGPTActive prompts are sent daily to third-party AI search engines (for example ChatGPT, Gemini and Perplexity) on Pineprompt's schedule, which uses plan quota. Create a new prompt for a monitor. The prompt will run against the monitor's configured AI platforms on schedule when is_active is true. Subject to the organization's plan quota.
create-segment-tool
ChatGPTCreate a new segment for a project. Segment names are unique per project, case-insensitive, so sending a duplicate (in any casing) returns an error.
create-tag-tool
ChatGPTCreate a new tag for a project. Requires a name (unique per project, case-insensitive, so sending a duplicate in any casing returns an error) and a color from the preset palette.
delete-invitation-tool
ChatGPTCancel a pending invitation.
delete-monitor-tool
ChatGPTDelete a monitor. The monitor stops running immediately. The monitor and its historical responses are soft-deleted, retained for 30 days, and then permanently removed.
delete-organization-tool
ChatGPTDelete an organization. Its subscription is canceled immediately. The organization and everything in it, including projects, monitors, and historical data, is soft-deleted, retained for 30 days, and then permanently removed.
delete-project-tool
ChatGPTDelete a project. Its monitors stop running immediately. The project and everything beneath it, including its historical data, is soft-deleted, retained for 30 days, and then permanently removed.
delete-prompt-tool
ChatGPTDelete a prompt. The prompt stops running immediately. The prompt and its historical responses are soft-deleted, retained for 30 days, and then permanently removed.
delete-segment-tool
ChatGPTDelete a segment. Attached brands are untouched but the segment stops appearing on them; a brand whose only segment this was derives back to discovered. The segment is soft-deleted, retained for 30 days, and then permanently removed. A project must keep at least one segment, so deleting the last one returns an error.
delete-tag-tool
ChatGPTDelete a tag. Attached prompts are untouched but the tag stops appearing on them. The tag is soft-deleted, retained for 30 days, and then permanently removed.
delete-user-tool
ChatGPTRemove a user from an organization. The organization owner cannot be removed.
detach-brand-from-segment-tool
ChatGPTDetach a brand from a segment. Idempotent: detaching a brand that is not attached succeeds without change. Both the brand and the segment must belong to the same project. Membership is what makes a brand a competitor, so detaching one from its only segment stops tracking it and it derives back to discovered, returning to the discover pool with its mention history intact. The own brand is implicit in every segment and cannot be detached.
detach-tag-from-prompt-tool
ChatGPTDetach a tag from a prompt. Idempotent: detaching a tag that is not attached succeeds without change. Both the prompt and the tag must belong to the same project.
get-brand-mention-tool
ChatGPTFetch a single brand mention by its numeric id. If you would like to embed the brand it points to, or a deeper parent chain, you may pass include.
get-citation-tool
ChatGPTFetch a single citation by its numeric id. Optionally pass include to load parent chains.
get-monitor-tool
ChatGPTFetch a single monitor by its numeric id. Optionally pass include to load the parent project chain (project, project.organization).
get-organization-tool
ChatGPTFetch a single organization by its numeric id.
get-position-time-series-tool
ChatGPTAverage position of each tracked brand within the answers that mention it, per bucket. Position counts brands in the order they appear in an answer, so a lower number is more prominent and 1 is the first brand named. Scope by brand_id for one line; by segments for that segment's brands; otherwise top top_n by mention count (default 20, max 50). Per-bucket value is null when the brand had no mentions in that bucket.
get-project-tool
ChatGPTFetch a single project by its numeric id. Optionally pass include to load the parent organization.
get-prompt-tool
ChatGPTFetch a single prompt by its numeric id. Optionally pass include to load the parent monitor/project/organization chain.
get-response-tool
ChatGPTFetch a single AI response by its numeric id. Optionally pass include to load parent chains. Brand mentions and citations are not embedded; query /v1/brand-mentions and /v1/citations separately.
get-segment-tool
ChatGPTFetch a single segment by its numeric id. Optionally pass include to load the parent project chain.
get-sentiment-time-series-tool
ChatGPTAverage sentiment score (0-100) of each tracked brand's mentions per bucket. Scope by brand_id for one line; by segments for that segment's brands; otherwise top top_n by mention count (default 20, max 50). Per-bucket value is null when the brand had no mentions in that bucket.
get-share-of-voice-time-series-tool
ChatGPTEach tracked brand's mentions as a percentage of the mentions of the brands in the filter scope, per bucket. Scope by brand_id for one line, which reads 100 in any bucket where the brand has mentions; by segments to read each share within the segment's brands; otherwise the scope is every tracked brand in the project and the result is capped to the top top_n series (default 20, max 50). The cap never affects the denominator.
get-source-tool
ChatGPTFetch a single source by its numeric id. Optionally pass include to load the parent project chain.
get-source-type-analytics-tool
ChatGPTCitation breakdown by source-type classification (e.g. blog, news, forum). Unpaginated: one row per source-type enum value. Cannot be scoped by segment.
get-source-url-type-analytics-tool
ChatGPTCitation breakdown by URL-type classification (e.g. article, documentation, product_page). Unpaginated: one row per URL-type enum value. Cannot be scoped by segment.
get-source-url-usage-time-series-tool
ChatGPTFor each top URL, the percentage of analyzed responses in the bucket that cited that exact URL. Capped to the top top_n URLs (default 20, max 50).
get-source-usage-time-series-tool
ChatGPTFor each top source, the percentage of analyzed responses in the bucket that cited any URL from that source. Capped to the top top_n sources (default 20, max 50).
get-tag-tool
ChatGPTFetch a single tag by its numeric id. Optionally pass include to load the parent project chain.
get-visibility-time-series-tool
ChatGPTReturns the share of analyzed responses that mention each tracked brand, bucketed by interval (day/week/month/year). Scope by brand_id for one line; by segments for that segment's brands; otherwise top top_n by mention count (default 20, max 50).
list-brand-analytics-tool
ChatGPTPer-brand aggregates over the filter window: visibility, share-of-voice, average sentiment, and average position. Returns one row for every tracked brand in scope; brands with no mentions in the window appear with zero visibility and share-of-voice and a null sentiment and position. Paginated.
list-brand-mentions-tool
ChatGPTList the brand mentions detected across a project, newest first. Returns up to 50 per page; follow nextCursor to fetch additional pages. Optionally pass include to load parent chains (response, brand, project, organization).
list-brands-tool
ChatGPTList the brands configured for a project, newest first. Returns up to 50 per page; follow nextCursor to fetch additional pages. Optionally pass include to load the parent project chain.
list-citations-tool
ChatGPTList the citations collected across a project, newest first. Each citation carries the URL the platform linked plus its domain. Returns up to 50 per page; follow nextCursor to fetch additional pages. Optionally pass include to load parent chains (response, source_url, source, project).
list-monitor-analytics-tool
ChatGPTPer-monitor aggregates (visibility, share-of-voice, sentiment, position) scoped to a single brand. Paginated.
list-monitors-tool
ChatGPTList the monitors configured for a project, newest first. Returns up to 50 per page; follow nextCursor to fetch additional pages. Optionally pass include to load the parent project chain (project, project.organization).
list-organizations-tool
ChatGPTList the organizations you belong to, newest first. Returns up to 50 per page; follow nextCursor to fetch additional pages. Each item includes the organization's id, name, and the user's role. Use this as the entry point to discover ids for other tools.
list-platform-analytics-tool
ChatGPTPer-AI-platform aggregates (visibility, share-of-voice, sentiment, position, used_count) scoped to a single brand. One row per platform present in the filtered response set; sorted by visibility desc.
list-projects-tool
ChatGPTList the projects within an organization, newest first. Returns up to 50 per page; follow nextCursor to fetch additional pages. Optionally pass include to load the parent organization.
list-prompt-analytics-tool
ChatGPTPer-prompt aggregates (visibility, share-of-voice, sentiment, position) scoped to a single brand, plus the distinct tracked brands mentioned in each prompt's responses during the window. Paginated. To fetch more rows, request the next page; the envelope reports the total under meta.last_page.
list-prompts-tool
ChatGPTList the prompts configured for a monitor, newest first. Returns up to 50 per page; follow nextCursor to fetch additional pages. Optionally pass include to load the parent monitor/project/organization chain.
list-responses-tool
ChatGPTList the AI responses collected for a project, newest first. Returns up to 50 per page; follow nextCursor to fetch additional pages. Optionally pass prompt_id to return only the responses for a single prompt, or source_url_id to return only the responses that cite a given source URL. Pass include to load parent chains (prompt, monitor, project, organization). Brand mentions and citations are not embedded; query /v1/brand-mentions and /v1/citations separately.
list-segments-tool
ChatGPTList the segments configured for a project, newest first. Returns up to 50 per page; follow nextCursor to fetch additional pages. Optionally pass include to load the parent project chain.
list-source-analytics-tool
ChatGPTPer-source aggregates: the percentage of analyzed responses in the window that cited each domain, and the average number of citations from each domain per analyzed response. Paginated.
list-source-url-analytics-tool
ChatGPTPer-URL aggregates: the percentage of analyzed responses in the window that cited each URL, and the average citation count for each URL per analyzed response. Paginated.
list-source-url-prompt-analytics-tool
ChatGPTPer-prompt citation analytics scoped to one source URL: how many distinct analyzed responses on each prompt cited the URL in the window, plus the most recent citation date. Paginated.
list-sources-tool
ChatGPTList the sources cited by AI platforms when responding to a project's prompts, ordered by domain. Returns up to 50 per page; follow nextCursor to fetch additional pages. Optionally pass include to load the parent project chain.
list-tags-tool
ChatGPTList the tags configured for a project, newest first. Returns up to 50 per page; follow nextCursor to fetch additional pages. Optionally pass include to load the parent project chain.
list-users-tool
ChatGPTList the members of an organization, ordered by name. Returns up to 50 per page; follow nextCursor to fetch additional pages.
update-brand-tool
ChatGPTOverwrites the given fields; previous values are not kept. Update a brand's display name, aliases, domains, or ignored state. Every field is optional, so send only the fields to change; the aliases and domains lists replace the current ones in full. A brand's kind is derived from context rather than written: pass ignored: true to stop tracking a brand (it is detached from every segment as the mark is set), ignored: false to return an ignored brand to the discovered pool, attach it to a segment to make it a competitor, or designate it through the update-project tool's brand_id to make it the own brand. The own brand cannot be ignored.
update-monitor-tool
ChatGPTActive prompts are sent daily to third-party AI search engines (for example ChatGPT, Gemini and Perplexity) on Pineprompt's schedule, which uses plan quota. Overwrites the given fields; previous values are not kept. Update an existing monitor. Every field is optional, so send only the fields to change; a field that is omitted keeps its current value. Platforms sent without a country are validated against the monitor's stored country, and a country sent without platforms must be supported by every platform the monitor already runs on.
update-organization-tool
ChatGPTOverwrites the given fields; previous values are not kept. Update an existing organization. Every field is optional; a field that is omitted keeps its current value.
update-project-tool
ChatGPTOverwrites the given fields; previous values are not kept. Update an existing project. Every field is optional, so send only the fields to change; a field that is omitted keeps its current value. Pass brand_id to designate one of the project's brands as its own brand, the one visibility is anchored against. The own brand is implicit in every segment and is never ignored, so it leaves any segments and sheds any ignored mark as it takes the role; a previous own brand derives back to discovered. Pass null to leave the project without an own brand.
update-prompt-tool
ChatGPTActive prompts are sent daily to third-party AI search engines (for example ChatGPT, Gemini and Perplexity) on Pineprompt's schedule, which uses plan quota. Overwrites the given fields; previous values are not kept. Update an existing prompt. Every field is optional, so send only the fields to change; a field that is omitted keeps its current value. Pass monitor_id to move the prompt to another monitor in the same project (collected responses move with it), or tags to replace the prompt's full set of tag ids.
update-segment-tool
ChatGPTOverwrites the given fields; previous values are not kept. Rename an existing segment. The name is optional, so a call that omits it leaves the segment unchanged. Names are unique per project, case-insensitive, so renaming to a duplicate (in any casing) returns an error.
update-tag-tool
ChatGPTOverwrites the given fields; previous values are not kept. Update an existing tag's name and color. Every field is optional, so send only the fields to change; a field that is omitted keeps its current value. Names are unique per project, case-insensitive, so renaming to a duplicate (in any casing) returns an error.
update-user-tool
ChatGPTOverwrites the given fields; previous values are not kept. Change a user's role within an organization. Allowed roles are admin and member; the organization owner's role cannot be changed and users cannot be promoted to owner.
