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

# Pause an agent (one-way, there is no resume)

> Pauses a running agent: its provider subscriptions (for a scrape, its recurring schedule) stop, `status` becomes `paused`, and no further results are delivered or billed. Already-delivered rows stay in the results list. This is one-way through the API: `activate` only accepts drafts, so a paused agent cannot be resumed here; duplicate it and activate the copy instead. A draft has nothing to pause and is refused with 409 AGENT_NOT_RUNNING (pausing one would strand it: activate takes drafts only). An agent that has already expired can still be paused and answers 200. Answers 200 with the agent as GET returns it.

Errors:
- `404` `AGENT_NOT_FOUND` — No agent with this id belongs to the token owner. A deleted agent and another user's agent answer identically.
- `409` `AGENT_NOT_RUNNING` — The agent has nothing to pause: it is still a draft (`initializing`), or its provider subscription is already gone. Drafts are refused deliberately, because a paused draft could never be started again (activate accepts drafts only).
- `422` `VALIDATION_FAILED` — The request failed this endpoint's own validation — `param` names the offending field and `message` says why.
- `429` `RATE_LIMITED` — The agents bucket is exhausted: 30 requests per minute or 2,000 per day per token owner, shared by every /business/agents operation (a 429 raised by the agents service is relayed with this code too). Retry after the `Retry-After` header.
- `500` `UNEXPECTED_ERROR` — The agents service failed (5xx, refused service credential, or a timeout after 60s) or the rate limiter was unavailable. Retry later; quote `request_id` to support.

Requires one of the following token scopes: agents.



## OpenAPI

````yaml /openapi.json post /business/agents/{agentId}/stop
openapi: 3.1.0
info:
  title: Fuse Business API
  version: 1.0.0
  description: >-
    External API for lists, campaigns, prospect search and contacts.
    Authenticate with your API token as HTTP Basic. All paths are under /api/v1.
servers:
  - url: https://api.tryfuse.ai/api/v1
    description: Production
security:
  - basicAuth: []
tags:
  - name: Lists
  - name: Custom columns
  - name: Smart columns
  - name: Exports
  - name: Campaigns
  - name: Knowledge hubs
  - name: Analytics
  - name: Website intent
  - name: Account
  - name: Prospect search
  - name: Campaign steps
  - name: Scheduled sends
  - name: Campaign templates
  - name: Agents
  - name: Research
  - name: Company search
  - name: Saved searches
  - name: Folders
  - name: Contacts
paths:
  /business/agents/{agentId}/stop:
    post:
      tags:
        - Agents
      summary: Pause an agent (one-way, there is no resume)
      description: >-
        Pauses a running agent: its provider subscriptions (for a scrape, its
        recurring schedule) stop, `status` becomes `paused`, and no further
        results are delivered or billed. Already-delivered rows stay in the
        results list. This is one-way through the API: `activate` only accepts
        drafts, so a paused agent cannot be resumed here; duplicate it and
        activate the copy instead. A draft has nothing to pause and is refused
        with 409 AGENT_NOT_RUNNING (pausing one would strand it: activate takes
        drafts only). An agent that has already expired can still be paused and
        answers 200. Answers 200 with the agent as GET returns it.


        Errors:

        - `404` `AGENT_NOT_FOUND` — No agent with this id belongs to the token
        owner. A deleted agent and another user's agent answer identically.

        - `409` `AGENT_NOT_RUNNING` — The agent has nothing to pause: it is
        still a draft (`initializing`), or its provider subscription is already
        gone. Drafts are refused deliberately, because a paused draft could
        never be started again (activate accepts drafts only).

        - `422` `VALIDATION_FAILED` — The request failed this endpoint's own
        validation — `param` names the offending field and `message` says why.

        - `429` `RATE_LIMITED` — The agents bucket is exhausted: 30 requests per
        minute or 2,000 per day per token owner, shared by every
        /business/agents operation (a 429 raised by the agents service is
        relayed with this code too). Retry after the `Retry-After` header.

        - `500` `UNEXPECTED_ERROR` — The agents service failed (5xx, refused
        service credential, or a timeout after 60s) or the rate limiter was
        unavailable. Retry later; quote `request_id` to support.


        Requires one of the following token scopes: agents.
      operationId: pauseAgent
      parameters:
        - name: agentId
          in: path
          required: true
          description: >-
            The agent's id: a 24-character hex string — the `id` of an item from
            GET /business/agents, or the `agent.id` a create or duplicate
            returned.
          schema:
            type: string
            description: >-
              The agent's id: a 24-character hex string — the `id` of an item
              from GET /business/agents, or the `agent.id` a create or duplicate
              returned.
      responses:
        '200':
          description: Success
          headers:
            RateLimit-Limit:
              schema:
                type: integer
              description: Requests permitted in the current window.
            RateLimit-Remaining:
              schema:
                type: integer
              description: Requests remaining in the current window.
            RateLimit-Reset:
              schema:
                type: integer
              description: Seconds until the current window resets.
          content:
            application/json:
              schema:
                type: object
                required:
                  - agent
                properties:
                  agent:
                    type: object
                    required:
                      - id
                      - type
                      - name
                      - status
                      - config
                      - isReconstructed
                      - lossyFields
                      - sourceLists
                    properties:
                      id:
                        type: string
                        description: >-
                          The agent's id — pass it as `{agentId}` to every other
                          agent operation.
                      type:
                        type:
                          - string
                          - 'null'
                        enum:
                          - web-monitor
                          - person-starting-new-job
                          - linkedin-posts
                          - person-discovery-via-filters
                          - job-postings
                          - job-posting-in-location
                          - first-person-hired-in-company-department
                          - first-person-hired-internationally
                          - company-headcount-growth
                          - company-headcount-growth-over-baseline
                          - company-department-headcount
                          - company-employee-job-location-in-two-countries
                          - funding-announcements
                          - people-watcher
                          - companies-watcher
                          - job-changes-watcher
                          - linkedin-profile
                          - linkedin-post
                          - null
                        description: >-
                          The public agent kind — the same slug you POST to at
                          /business/agents/{type}. null for a legacy kind this
                          API no longer offers.
                      name:
                        type: string
                        description: >-
                          The agent's name, which is also the name of the
                          results list it delivers into.
                      status:
                        type: string
                        enum:
                          - initializing
                          - processing
                          - active
                          - paused
                          - expired
                          - failed
                          - completed
                          - deleted
                        description: >-
                          initializing = saved draft, nothing billed; processing
                          = a run is under way; active = running; paused =
                          stopped by you; expired = past its expirationDate;
                          failed = the provider setup failed. Older agents can
                          also read `completed` (a one-off scrape that has
                          finished) and `deleted` (an agent deleted before
                          deletions were timestamped: still readable, but it can
                          no longer be edited or activated).
                      config:
                        type: object
                        additionalProperties: true
                        description: >-
                          The agent's config in CREATE shape: exactly the body
                          you would POST to /business/agents/{type} (without
                          `start`) to build this agent again. Its fields are the
                          ones documented on that type's create operation.
                      isReconstructed:
                        type: boolean
                        description: >-
                          false = the config is the stored snapshot, returned
                          verbatim (always the case for a draft). true = the
                          agent was started before its snapshot existed and the
                          config was rebuilt from the live record, so check
                          `lossyFields`.
                      lossyFields:
                        type: array
                        items:
                          type: string
                        description: >-
                          Config fields that could not be recovered when
                          `isReconstructed` is true; `["*"]` means only `name`
                          is known. Empty otherwise.
                      sourceLists:
                        type: array
                        description: >-
                          Watcher kinds only: the source lists the config names,
                          resolved to their names. Empty for every other kind.
                        items:
                          type: object
                          required:
                            - id
                            - name
                          properties:
                            id:
                              type: string
                              description: The source list's id.
                            name:
                              type:
                                - string
                                - 'null'
                              description: >-
                                The source list's name, or null when the list
                                has been deleted.
              example:
                agent:
                  id: 6a8d7a5032fd74700391356b
                  type: companies-watcher
                  name: Fundraising Sofiia 25 aug
                  status: paused
                  config:
                    listName: Fundraising Sofiia 25 aug
                    eventType: company-watch-funding-milestones
                    listIds:
                      - 6a7ef6d7d1d092349bbf5db5
                    expirationDate: '2026-08-26'
                    frequency: 1
                    maxContacts: 50
                  isReconstructed: true
                  lossyFields: []
                  sourceLists:
                    - id: 6a7ef6d7d1d092349bbf5db5
                      name: tegna_44 - Companies
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - basicAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            param:
              type:
                - string
                - 'null'
            doc_url:
              type:
                - string
                - 'null'
            request_id:
              type:
                - string
                - 'null'
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        Your API token (`af_…`) as the Basic-auth username, with an empty
        password.

````