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

# Resume a keyword

> Starts every search that can follow. A Source an operator stopped stays stopped and is named in `blockedSources` rather than failing the call — the other Sources have no reason to stay down for it.



## OpenAPI

````yaml /openapi.json post /v1/keywords/{id}/resume
openapi: 3.1.0
info:
  title: Nephia API
  description: >-
    The brand-monitoring API. Create a **keyword** and it polls the live Sources
    (X, Reddit, Youtube, TikTok, Bluesky, Hacker News, Mastodon, Lemmy, GitHub,
    Product Hunt, Stack Overflow, RSS, AI answers and Vinted) on an interval,
    keeps what matches, reads each mention for sentiment and intent, sorts it
    into your buckets and answers your own agent step over it. Read the result
    back as **mentions** (`GET /v1/mentions` across the whole Account, or per
    keyword), or have it pushed to you as signed webhook events and delivery
    channels. A search can carry several terms at once, OR'd into one upstream
    request at one tick's cost. Authenticate with an API key on your Account.
    Monitoring is sold as a subscription (keywords, terms, freshness and AI)
    with credits as the meter underneath; credit packs are overflow and never
    change a limit. Reading your own mentions is free; the semantic search mode
    and the AI passes are what meter. Request quota is per Account (all API keys
    share one bucket), by Plan: Free 60/min, Solo 350/min, Growth 700/min, Pro
    1200/min.
  version: 1.0.0
servers:
  - url: https://api.nephia.cc
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Account
    description: Account balance
  - name: Mentions
    description: Everything your keywords caught, across every Source
  - name: Keywords
    description: >-
      What you monitor. A keyword carries its terms, its Sources and its
      settings. Read, create, edit and pause them here.
  - name: Explore
    description: >-
      One question asked of the Sources once, priced first, without creating a
      keyword
  - name: AI
    description: Group, classify, agent and summarise passes over items you name
  - name: Vinted analytics
    description: Observed price history and per-day market statistics
paths:
  /v1/keywords/{id}/resume:
    post:
      tags:
        - Keywords
      summary: Resume a keyword
      description: >-
        Starts every search that can follow. A Source an operator stopped stays
        stopped and is named in `blockedSources` rather than failing the call —
        the other Sources have no reason to stay down for it.
      operationId: postV1KeywordsByIdResume
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          required: true
        - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '200':
          description: Keyword resumed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeywordLifecycleResponse'
        '404':
          description: Keyword not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
        '429':
          description: >-
            Request quota exceeded. Retry after the `Retry-After` header
            (seconds). Response includes `RateLimit-*` headers (IETF draft-7).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
              example:
                error: Rate limit exceeded
                code: TOO_MANY_REQUESTS
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        maxLength: 255
      description: >-
        Unique key (e.g. UUID) making this POST safe to retry for 24 hours.
        Replays return the original response with an `Idempotency-Replayed:
        true` header; reusing a key with a different body returns 422.
  schemas:
    KeywordLifecycleResponse:
      type: object
      properties:
        keyword:
          $ref: '#/components/schemas/Keyword'
        blockedSources:
          type: array
          items:
            type: object
            properties:
              source:
                type: string
                enum:
                  - x
                  - reddit
                  - youtube
                  - tiktok
                  - bluesky
                  - hackernews
                  - mastodon
                  - lemmy
                  - github
                  - producthunt
                  - stackoverflow
                  - rss
                  - ai_answers
                  - vinted
              reason:
                type: string
            required:
              - source
              - reason
      required:
        - keyword
        - blockedSources
    Keyword:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        kind:
          type: string
          enum:
            - catalog
            - listening
        globalCriteria:
          type: object
          additionalProperties: {}
        refreshIntervalSeconds:
          type: number
        sources:
          type: array
          items:
            $ref: '#/components/schemas/KeywordSource'
        webhookUrl:
          type:
            - string
            - 'null'
        webhookMode:
          type: string
          enum:
            - all
            - rules
        webhookEvents:
          type: array
          items:
            type: string
            enum:
              - keyword.alert_fired
              - keyword.report_ready
              - keyword.paused
              - keyword.resumed
              - channel.disabled
        aiEnabled:
          type: boolean
        aiPreset:
          type:
            - string
            - 'null'
        aiPrompt:
          type:
            - string
            - 'null'
        aiStep:
          type:
            - object
            - 'null'
          additionalProperties: {}
        sentimentEnabled:
          type: boolean
        coBrandsEnabled:
          type: boolean
        subjectRole:
          type: string
          enum:
            - own
            - competitor
            - topic
        muteRules:
          type: array
          items: {}
        vipAuthors:
          type: array
          items: {}
        rules:
          type: array
          items: {}
        schedule:
          type:
            - object
            - 'null'
          additionalProperties: {}
        isActive:
          type: boolean
        pausedReason:
          type:
            - string
            - 'null'
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
        - id
        - name
        - kind
        - globalCriteria
        - refreshIntervalSeconds
        - sources
        - webhookUrl
        - webhookMode
        - webhookEvents
        - aiEnabled
        - aiPreset
        - aiPrompt
        - aiStep
        - sentimentEnabled
        - coBrandsEnabled
        - subjectRole
        - muteRules
        - vipAuthors
        - rules
        - schedule
        - isActive
        - pausedReason
        - createdAt
        - updatedAt
    KeywordSource:
      type: object
      properties:
        source:
          type: string
          enum:
            - x
            - reddit
            - youtube
            - tiktok
            - bluesky
            - hackernews
            - mastodon
            - lemmy
            - github
            - producthunt
            - stackoverflow
            - rss
            - ai_answers
            - vinted
        enabled:
          type: boolean
        searches:
          type: array
          items:
            $ref: '#/components/schemas/KeywordSearch'
        refreshIntervalSeconds:
          type:
            - number
            - 'null'
      required:
        - source
        - enabled
        - searches
        - refreshIntervalSeconds
    KeywordSearch:
      type: object
      properties:
        id:
          type: string
        label:
          type:
            - string
            - 'null'
        overridesEnabled:
          type: boolean
        overrides:
          type: object
          additionalProperties: {}
        resolvedCriteria:
          type: object
          additionalProperties: {}
      required:
        - id
        - label
        - overridesEnabled
        - overrides
        - resolvedCriteria
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key created from the Nephia dashboard for your Account.

````