Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

LOCAL DRAFT PREVIEW. Not published. Pages tagged Draft are new, pages tagged Updated have additions. Yellow 'To confirm' boxes are internal questions.

Fini home pagelight logodark logo
    Documentation
    Use cases
    Trust & pricing
    API reference

    API Setup

    • API overview
    • API contract
    • Static IP Addresses
    • Database and Warehouse Connections
    • MCP Connections

    LLM Access

    • Coding agents
    • Claude Plugin

    Agents

    • Overview
    • POST
      Create agent
    • List agents
    • DEL
      Delete agent

    Analytics

    • Overview
    • Get agent analytics
    • Get agent analytics section

    Prompts

    • Overview
    • Get prompts
    • Get prompt history
    • Get prompt version
    • Update prompts
    • POST
      Create prompt draft version
    • Get prompt draft version
    • Publish prompt draft version
    • DEL
      Delete prompt draft version

    Actions

    • Overview
    • List actions
    • Get action
    • POST
      Create action
    • Update action
    • DEL
      Delete action
    • Test action
    • List agent assignments
    • POST
      Assign to agents

    Attributes

    • Overview
    • List attributes
    • Get attribute
    • POST
      Create attribute
    • Update attribute
    • DEL
      Delete attribute
    • Test attribute
    • List agent assignments
    • POST
      Assign to agents

    External API calls

    • Overview
    • List external API calls
    • Get external API call
    • POST
      Create external API call
    • Update external API call
    • DEL
      Delete external API call
    • Test external API call

    Intent Rules

    • Overview
    • List intent rules
    • Get intent rule
    • Get intent-rule fields context
    • POST
      Generate intent-rule draft with AI
    • POST
      Create intent rule
    • Update intent rule
    • List intent-rule versions
    • Get intent-rule version
    • Publish intent-rule draft
    • Restore intent-rule version as draft
    • DEL
      Delete intent-rule draft version
    • Get rule version test paths
    • Preview rule test paths
    • Run rule version test path
    • Run rule test path from config
    • DEL
      Delete intent rule

    Guardrails

    • Overview
    • List guardrail check types
    • List guardrail policies
    • Get guardrail policy
    • POST
      Create guardrail policy
    • Update guardrail policy
    • DEL
      Delete guardrail policy
    • List guardrail runs
    • Get guardrail hits

    Business Rules

    • Overview
    • List Business Rules
    • Get Business Rule
    • Get Business Rule fields context
    • List default Business Rules
    • POST
      Create Business Rule
    • POST
      Duplicate Business Rule
    • POST
      Evaluate Business Rule
    • Get Business Rule test fields
    • Preview Business Rule test fields
    • Update Business Rule
    • DEL
      Delete Business Rule

    Reply Rules

    • Overview
    • Get reply rules
    • Get reply rule fields context
    • Update reply rule

    Tag groups

    • Overview
    • List tag groups
    • Get tag group
    • POST
      Create tag group
    • Update tag group
    • DEL
      Delete tag group

    Tags

    • Overview
    • Get tag
    • List tags in group
    • List tags across groups
    • POST
      Create tag
    • Update tag
    • DEL
      Delete tag

    Conversations

    • Overview
    • List conversations
    • Get conversation
    • Get event metadata
    • POST
      Generate Answer
    • Send conversation feedback
    • Mark feedback resolved
    • POST
      Add feedback note
    • POST
      Evaluate conversation rule
    • DEL
      Delete conversation
    • DEL
      Bulk delete conversations

    Refine with AI

    • Overview
    • POST
      Create Refine with AI iteration
    • Get active Refine with AI session
    • Get Refine with AI session

    Replays

    • Replays
    • POST
      Create replay
    • List replays
    • Get replay
    • Get replay events

    Test Sets

    • Overview
    • List test sets
    • POST
      Create a test set
    • Get fields context
    • Get a test set
    • Update a test set
    • DEL
      Delete a test set
    • POST
      Add criteria
    • Update a criterion
    • DEL
      Delete a criterion
    • List runs
    • Start a run
    • Get a run

    Knowledge

    Updates

    • Changelog
      Draft
    Agents

    List agents

    > ## Documentation Index
    > Fetch the complete documentation index at: https://docs.usefini.com/llms.txt
    > Use this file to discover all available pages before exploring further.
    
    # List agents
    
    > List workspace agents with their IDs and serialized prompt text.
    
    Returns every non-deleted agent in the workspace tied to your API key, sorted by most recently updated first. Each item includes the agent ID, name, creation timestamp, and serialized planning, guideline, email-channel, and chat-channel prompts.
    
    Use this endpoint to look up the `botId` values accepted by [List conversations](/en/api-reference/list-conversations), [Generate Answer](/en/api-reference/generate-answer), and other public routes that scope behavior to one agent. For structured prompt sections, use [Get prompts](/en/api-reference/get-prompts).
    
    For the full agent endpoint family, including create and delete routes, see [Agents](/en/api-reference/agents). Use [Analytics](/en/api-reference/analytics) for agent-level reporting endpoints and [Prompts](/en/api-reference/prompts) for prompt-version routes.
    
    This endpoint returns all agents in a single response, there is no pagination, filtering, or limit.
    
    <Info>
      The endpoint path uses `/bots` because that is the current API contract. In the dashboard and the rest of these docs, the same workspace entities are called agents.
    </Info>
    
    ## Headers
    
    <ParamField header="Authorization" type="string" required>
      Bearer token containing your Fini workspace API key. Format: `Bearer fini_...` The key needs `read` scope.
    </ParamField>
    
    <RequestExample>
      ~~~bash cURL theme={null}
      curl --request GET \
        --url 'https://api-prod.usefini.com/v2/bots/public' \
        --header 'Authorization: Bearer fini_your_api_key'
      ~~~
    
      ~~~python Python theme={null}
      import requests
    
      response = requests.get(
          "https://api-prod.usefini.com/v2/bots/public",
          headers={"Authorization": "Bearer fini_your_api_key"},
      )
      agents = response.json()
      ~~~
    
      ~~~javascript Node.js theme={null}
      const response = await fetch(
        "https://api-prod.usefini.com/v2/bots/public",
        {
          headers: {
            Authorization: "Bearer fini_your_api_key",
          },
        }
      );
      const agents = await response.json();
      ~~~
    </RequestExample>
    
    ## Response
    
    The response is a top-level array of agent objects.
    
    <ResponseField name="[]" type="array">
      Array of agents in the workspace.
    
      <Expandable title="agent object">
        <ResponseField name="id" type="string">
          The agent's `botId`. Pass this value as `botId` on endpoints that support agent-level filtering.
        </ResponseField>
    
        <ResponseField name="name" type="string">
          Agent name as configured in the workspace.
        </ResponseField>
    
        <ResponseField name="createdAt" type="datetime">
          ISO 8601 timestamp for when the agent was created.
        </ResponseField>
    
        <ResponseField name="hcPlanningPrompt" type="string">
          Serialized planning prompt built from enabled planning sections and subsections.
        </ResponseField>
    
        <ResponseField name="hcGuidelinePrompt" type="string">
          Serialized main-guidelines prompt built from enabled guideline sections and subsections.
        </ResponseField>
    
        <ResponseField name="hcEmailChannelPrompt" type="string">
          Serialized prompt for enabled email-channel sections. An empty string means no enabled email prompt content is available.
        </ResponseField>
    
        <ResponseField name="hcChatChannelPrompt" type="string">
          Serialized prompt for enabled chat-channel sections. An empty string means no enabled chat prompt content is available.
        </ResponseField>
      </Expandable>
    </ResponseField>
    
    <Note>
      The four prompt fields are rendered strings intended for inspection or downstream text use. They include enabled prompt sections serialized from the agent prompt configuration. To edit prompts or preserve section IDs and ordering, read the structured arrays from [Get prompts](/en/api-reference/get-prompts).
    </Note>
    
    <ResponseExample>
      ~~~json 200 OK theme={null}
      [
        {
          "id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
          "name": "Support Agent",
          "createdAt": "2026-05-20T12:34:56.789Z",
          "hcPlanningPrompt": "<PLANNING>\n\n## PLAN THE RESPONSE\n...\n\n</PLANNING>\n\n\n",
          "hcGuidelinePrompt": "<MAIN GUIDELINES>\n\n## ANSWER ACCURATELY\n...\n\n</MAIN GUIDELINES>\n\n\n",
          "hcEmailChannelPrompt": "<EMAIL>\n\n## FORMAT\n...\n\n</EMAIL>\n\n\n",
          "hcChatChannelPrompt": "<CHAT>\n\n## FORMAT\n...\n\n</CHAT>\n\n\n"
        },
        {
          "id": "0f4da4fe-b2ae-4787-8c3b-854f36d9eb1b",
          "name": "Billing Agent",
          "createdAt": "2026-05-12T08:41:10.201Z",
          "hcPlanningPrompt": "<PLANNING>\n\n## PLAN THE RESPONSE\n...\n\n</PLANNING>\n\n\n",
          "hcGuidelinePrompt": "<MAIN GUIDELINES>\n\n## ANSWER ACCURATELY\n...\n\n</MAIN GUIDELINES>\n\n\n",
          "hcEmailChannelPrompt": "",
          "hcChatChannelPrompt": "<CHAT>\n\n## FORMAT\n...\n\n</CHAT>\n\n\n"
        }
      ]
      ~~~
    
      ~~~json 401 Unauthorized theme={null}
      {
        "statusCode": 401,
        "message": "Invalid or revoked API key",
        "error": "Unauthorized"
      }
      ~~~
    
      ~~~json 403 Forbidden theme={null}
      {
        "statusCode": 403,
        "message": "API key does not have the required scope for this operation",
        "error": "Forbidden"
      }
      ~~~
    </ResponseExample>
    
    ## Errors
    
    <AccordionGroup>
      <Accordion title="401 Unauthorized" icon="lock">
        The workspace API key is missing, malformed, revoked, or invalid. Confirm you are sending `Authorization: Bearer fini_...` with the full key.
      </Accordion>
    
      <Accordion title="403 Forbidden" icon="shield-halved">
        The key is valid but doesn't include the `read` scope, or it's scoped to a different workspace.
      </Accordion>
    
      <Accordion title="The response is an empty array" icon="circle-question">
        The key's workspace has no non-deleted agents available to the public route. Create an agent in the dashboard or confirm you're authenticating against the right workspace.
      </Accordion>
    </AccordionGroup>
    
    
    ## Related topics
    
    - [List agent assignments](/en/api-reference/list-attribute-agents.md)
    - [List conversations](/en/api-reference/list-conversations.md)
    - [Delete agent](/en/api-reference/delete-agent.md)
    
    
    This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.
    
    Create agent
    Delete agent
    Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform