> ## Documentation Index
> Fetch the complete documentation index at: https://docs.palagus.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Every tool, in plain words

> 12 tools: 9 that read your data and 3 that add to it. Your assistant picks them by itself from what you ask — this page is for knowing what is possible, not for typing tool names.

Your assistant may show a tool by its technical name, for example `list_responses`, when it asks whether to use it. Every tool carries a readable title as well; both are listed below.

## Reading

<AccordionGroup>
  <Accordion title={"List projects"} id={"list_projects"}>
    <Badge stroke>list\_projects</Badge> <Badge color="green">Reads</Badge>

    The projects (tracked brands) your account can see, with the workspace each belongs to. Assistants call it first to find the project you mean.

    **You can narrow it down by**

    * Include archived projects

    <sub>Permission: Read your projects and metrics · Every role in the project, viewers included</sub>
  </Accordion>

  <Accordion title={"Get project overview"} id={"get_project_overview"}>
    <Badge stroke>get\_project\_overview</Badge> <Badge color="green">Reads</Badge>

    Your brand and every tracked competitor side by side: visibility, share of voice, position and sentiment, each with its change against the period before and whether that change is larger than the measurement's margin.

    **You can narrow it down by**

    * Time window: the last hour up to the last year, everything, or two dates of your own
    * Compare with a period you name instead of the one just before — for example the week before a launch against the week after
    * Only certain AI engines, topics, personas or countries
    * Break your own numbers down by AI engine, persona or topic in the same answer, with the strongest competitor in each group
    * Measure every group against one competitor you choose

    <sub>Permission: Read your projects and metrics · Every role in the project, viewers included</sub>
  </Accordion>

  <Accordion title={"List prompts"} id={"list_prompts"}>
    <Badge stroke>list\_prompts</Badge> <Badge color="green">Reads</Badge>

    Your tracked prompts — the questions Palagus asks AI engines — each with its mentions, visibility, share of voice, position and sentiment, and how each moved.

    **You can narrow it down by**

    * Time window: the last hour up to the last year, everything, or two dates of your own

    * Only certain topics, personas, countries or AI engines

    * Sort by any of the numbers or by the largest rise or fall

    * Archived prompts instead of active ones

    * Returns up to 200 prompts and says when there were more.

    <sub>Permission: Read your projects and metrics · Every role in the project, viewers included</sub>
  </Accordion>

  <Accordion title={"List competitors"} id={"list_competitors"}>
    <Badge stroke>list\_competitors</Badge> <Badge color="green">Reads</Badge>

    The competitors your project is measured against, with their websites and other names, how each was added, and whether any answer mentions it.

    <sub>Permission: Read your projects and metrics · Every role in the project, viewers included</sub>
  </Accordion>

  <Accordion title={"Get top sources"} id={"get_top_sources"}>
    <Badge stroke>get\_top\_sources</Badge> <Badge color="green">Reads</Badge>

    The websites AI answers cite for your prompts, ranked, each marked as your own, a competitor's or a third party's — with two counts: every citation, and the number of answers that cite the site.

    **You can narrow it down by**

    * Time window: the last hour up to the last year, everything, or two dates of your own

    * Only your own, competitors' or third-party sites

    * Up to 50 sites

    * Needs the citations feature in your plan.

    * Counts websites (domains). Which single pages an answer cited is in the answer itself (Get response).

    <sub>Permission: Read your projects and metrics · Every role in the project, viewers included</sub>
  </Accordion>

  <Accordion title={"List responses"} id={"list_responses"}>
    <Badge stroke>list\_responses</Badge> <Badge color="green">Reads</Badge>

    The AI answers collected for your prompts, one excerpt each: which engine answered, from which country, whether and how your brand came up, and which competitors were named.

    **You can narrow it down by**

    * Time window: the last hour up to the last year, everything, or two dates of your own

    * Search the answers' own words

    * Only answers that mention you — or only those that do not

    * Only answers that name a given competitor, with or without you

    * Only certain AI engines, countries, topics or personas

    * Sort by date, sentiment, position or number of mentions

    * Up to 50 answers per page, with as many pages as there are answers.

    <sub>Permission: Read your projects and metrics · Every role in the project, viewers included</sub>
  </Accordion>

  <Accordion title={"Get response"} id={"get_response"}>
    <Badge stroke>get\_response</Badge> <Badge color="green">Reads</Badge>

    One AI answer in full: the complete text, the pages it cites, and how your brand came up in it.

    <sub>Permission: Read your projects and metrics · Every role in the project, viewers included</sub>
  </Accordion>

  <Accordion title={"List personas"} id={"list_personas"}>
    <Badge stroke>list\_personas</Badge> <Badge color="green">Reads</Badge>

    The personas your prompts are asked as — a buyer, a beginner, an expert — with how many prompts each one carries, so gaps in the prompt set show.

    <sub>Permission: Read your projects and metrics · Every role in the project, viewers included</sub>
  </Accordion>

  <Accordion title={"Get project timeline"} id={"get_project_timeline"}>
    <Badge stroke>get\_project\_timeline</Badge> <Badge color="green">Reads</Badge>

    How visibility, position and sentiment developed over time for your brand and every competitor — one point per hour, day, week or month, each with the number of answers behind it.

    **You can narrow it down by**

    * Time window: the last hour up to the last year, everything, or two dates of your own
    * Day, week or month per point
    * Only certain AI engines
    * Only some of the three curves

    <sub>Permission: Read your projects and metrics · Every role in the project, viewers included</sub>
  </Accordion>
</AccordionGroup>

## Adding and running

<AccordionGroup>
  <Accordion title={"Create topics"} id={"create_topics"}>
    <Badge stroke>create\_topics</Badge> <Badge color="blue">Creates</Badge>

    Adds topics to a project to group prompts by theme. A topic that already exists is reported as existing, not created twice.

    **You can narrow it down by**

    * Up to 50 topic names at once

    * Counts against your plan's topic quota — only names that are actually new.

    <sub>Permission: Create prompts and topics (a new prompt runs once right away) · Owner, Admin or Member</sub>
  </Accordion>

  <Accordion title={"Create prompts"} id={"create_prompts"}>
    <Badge stroke>create\_prompts</Badge> <Badge color="blue">Creates</Badge>

    Adds prompts to a project and runs each one once, right away, on the AI engines you choose — so the first answers arrive without waiting for the schedule.

    **You can narrow it down by**

    * Up to 50 prompts at once

    * Up to 10 AI engines your plan offers

    * A country the prompts are asked from

    * A persona per prompt

    * Up to 3 topics for all of them, created when missing

    * Counts against your plan's prompt quota and run budget.

    <sub>Permission: Create prompts and topics (a new prompt runs once right away) · Owner, Admin or Member</sub>
  </Accordion>

  <Accordion title={"Run prompt"} id={"run_prompt"}>
    <Badge stroke>run\_prompt</Badge> <Badge color="orange">Starts runs</Badge>

    Starts one extra run of a prompt you already track, on one AI engine, on top of the project's schedule — when a fresh answer is needed now.

    **You can narrow it down by**

    * The AI engine

    * A country

    * Uses run budget.

    <sub>Permission: Start runs, which cost run budget · Owner or Admin</sub>
  </Accordion>
</AccordionGroup>

## Not offered

There is no tool to change, archive or delete anything, and none for schedules or exports. That is on purpose: an assistant that misreads one sentence should not be able to remove your topics.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.