captapi-com Monitors API

Scheduled re-runs of an endpoint that POST new items to your webhook.

Operations 6

GET /v1/monitors List your monitors #
POST /v1/monitors Create a monitor #
GET /v1/monitors/{monitor_id} Get one monitor (includes webhook secret) #
PATCH /v1/monitors/{monitor_id} Update a monitor #
DELETE /v1/monitors/{monitor_id} Delete a monitor #
POST /v1/monitors/{monitor_id}/test Send a signed test payload to your webhook #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/captapi-com:captapi-com-monitors-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

captapi-com-monitors-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Captapi Monitors API
  version: 0.1.0
  summary: Structured public data from social platforms through one REST API.
  description: 'Captapi returns public data (profiles, posts, comments, transcripts, search, ads, commerce) from social platforms as JSON.


    Auth: send your key as `Authorization: Bearer capt_live_...` or `X-API-Key: capt_live_...`. Keys are created by a human at https://captapi.com/dashboard/api-keys.


    Billing: each operation states its cost in `x-credit-cost`. The `X-Captapi-Credits` response header shows what was charged. Failed requests (4xx/5xx) are not billed. `cache=true` serves from the 24h cache, free on a hit where `billedOnCacheHit` is false. Where the price depends on which path served the call, `x-credit-cost.note` gives the full rule and the range we have observed.


    Empty results: on many list and search endpoints a call that ran but found nothing is charged 0 credits (for example an ad-library or profile search with no matches). Where an empty result is still billed, the endpoint description says so; Google Maps business search, for instance, bills its one page because the lookup ran. The `X-Captapi-Credits` header always shows the actual charge.


    Errors: every non-2xx response uses the same envelope, `{ success: false, error: { code, message, retryable } }`. Retry only when `retryable` is true, honouring `Retry-After`.


    Timing: every response carries `Server-Timing: total;dur=`, the total time the request took. Deprecated: the `timings` object some endpoints still return in `data` will be removed from response bodies on 2026-12-17; use the header instead. It is not part of the response schemas below.


    Response schemas are inferred from real captured responses and list the fields seen there plus documented top-level fields. Fields can be null when a platform does not expose them.


    Endpoint list: https://captapi.com/llms-endpoints.txt · Guide for agents: https://captapi.com/llms.txt · MCP: https://captapi.com/mcp.json'
  contact:
    name: Captapi support
    email: support@captapi.com
    url: https://captapi.com
  termsOfService: https://captapi.com/legal/terms
  license:
    name: Captapi Terms of Service
    url: https://captapi.com/legal/terms
servers:
- url: https://api.captapi.com
security:
- bearerAuth: []
- apiKeyHeader: []
tags:
- name: Monitors
  description: Scheduled re-runs of an endpoint that POST new items to your webhook.
paths:
  /v1/monitors:
    get:
      operationId: list_monitors
      tags:
      - Monitors
      summary: List your monitors
      description: All monitors on your account, newest first. Secrets are not included. Free.
      security:
      - bearerAuth: []
      - apiKeyHeader: []
      x-credit-cost:
        label: 0 credits
        credits: 0
      x-one-liner: All monitors on your account, newest first.
      responses:
        '200':
          description: Success.
          headers:
            X-Captapi-Credits:
              $ref: '#/components/headers/Credits'
            X-Captapi-Cache:
              $ref: '#/components/headers/Cache'
            X-Captapi-Request-Id:
              $ref: '#/components/headers/RequestId'
            Server-Timing:
              $ref: '#/components/headers/ServerTiming'
          content:
            application/json:
              schema:
                type: object
                required:
                - success
                - data
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    properties:
                      monitors:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                            endpoint:
                              type: string
                            params:
                              type: object
                              properties:
                                url:
                                  type: string
                            interval_minutes:
                              type: integer
                            webhook_url:
                              type: string
                            active:
                              type: boolean
                            next_run_at:
                              type: string
                            created_at:
                              type: string
              example:
                success: true
                data:
                  monitors:
                  - id: 3f0c6a52-7f2e-4f4b-9a51-0d6b1f2c9e11
                    name: r/programming new posts
                    endpoint: /v1/reddit/subreddit-posts
                    params:
                      url: https://www.reddit.com/r/programming/
                    interval_minutes: 60
                    webhook_url: https://example.com/hooks/captapi
                    active: true
                    next_run_at: '2026-10-10T19:00:00+00:00'
                    created_at: '2026-10-10T18:00:00+00:00'
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '404':
          $ref: '#/components/responses/Error404'
        '422':
          $ref: '#/components/responses/Error422'
        '429':
          $ref: '#/components/responses/Error429'
    post:
      operationId: create_monitor
      tags:
      - Monitors
      summary: Create a monitor
      description: 'Re-runs a list-returning Captapi GET endpoint on your interval and POSTs only new items to your webhook. endpoint must be a Captapi GET path; webhook_url must be an external https URL. interval_minutes is 15-1440 (default 60), at most 20 monitors per account. Each delivery is signed: X-Captapi-Signature is sha256=HMAC-SHA256(secret, "{X-Captapi-Timestamp}.{raw body}"). The secret is generated when omitted and returned here. Managing monitors is free; each scheduled run is billed like calling the endpoint directly.'
      security:
      - bearerAuth: []
      - apiKeyHeader: []
      x-credit-cost:
        label: Free to manage; each scheduled run is billed like a direct call
        credits: 0
      x-one-liner: Re-runs a list-returning Captapi GET endpoint on your interval and POSTs only new items to your webhook.
      responses:
        '200':
          description: Success.
          headers:
            X-Captapi-Credits:
              $ref: '#/components/headers/Credits'
            X-Captapi-Cache:
              $ref: '#/components/headers/Cache'
            X-Captapi-Request-Id:
              $ref: '#/components/headers/RequestId'
            Server-Timing:
              $ref: '#/components/headers/ServerTiming'
          content:
            application/json:
              schema:
                type: object
                required:
                - success
                - data
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      endpoint:
                        type: string
                      params:
                        type: object
                        properties:
                          url:
                            type: string
                      interval_minutes:
                        type: integer
                      webhook_url:
                        type: string
                      active:
                        type: boolean
                      next_run_at:
                        type: string
                      created_at:
                        type: string
                      secret:
                        type: string
              example:
                success: true
                data:
                  id: 3f0c6a52-7f2e-4f4b-9a51-0d6b1f2c9e11
                  name: r/programming new posts
                  endpoint: /v1/reddit/subreddit-posts
                  params:
                    url: https://www.reddit.com/r/programming/
                  interval_minutes: 60
                  webhook_url: https://example.com/hooks/captapi
                  active: true
                  next_run_at: '2026-10-10T19:00:00+00:00'
                  created_at: '2026-10-10T18:00:00+00:00'
                  secret: whsec_3b9f0c2d7a6e41f8b5c09d1e2a7f4c6b8d0e1f2a3b4c5d6e
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '404':
          $ref: '#/components/responses/Error404'
        '422':
          $ref: '#/components/responses/Error422'
        '429':
          $ref: '#/components/responses/Error429'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitorCreate'
            example:
              name: r/programming new posts
              endpoint: /v1/reddit/subreddit-posts
              params:
                url: https://www.reddit.com/r/programming/
              interval_minutes: 60
              webhook_url: https://example.com/hooks/captapi
        required: true
  /v1/monitors/{monitor_id}:
    get:
      operationId: get_monitor
      tags:
      - Monitors
      summary: Get one monitor (includes webhook secret)
      description: One of your monitors, including its webhook secret. 404 when it is not yours. Free.
      security:
      - bearerAuth: []
      - apiKeyHeader: []
      parameters:
      - name: monitor_id
        in: path
        required: true
        schema:
          type: string
        example: 3f0c6a52-7f2e-4f4b-9a51-0d6b1f2c9e11
      x-credit-cost:
        label: 0 credits
        credits: 0
      x-one-liner: One of your monitors, including its webhook secret.
      responses:
        '200':
          description: Success.
          headers:
            X-Captapi-Credits:
              $ref: '#/components/headers/Credits'
            X-Captapi-Cache:
              $ref: '#/components/headers/Cache'
            X-Captapi-Request-Id:
              $ref: '#/components/headers/RequestId'
            Server-Timing:
              $ref: '#/components/headers/ServerTiming'
          content:
            application/json:
              schema:
                type: object
                required:
                - success
                - data
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      endpoint:
                        type: string
                      params:
                        type: object
                        properties:
                          url:
                            type: string
                      interval_minutes:
                        type: integer
                      webhook_url:
                        type: string
                      active:
                        type: boolean
                      next_run_at:
                        type: string
                      created_at:
                        type: string
                      secret:
                        type: string
              example:
                success: true
                data:
                  id: 3f0c6a52-7f2e-4f4b-9a51-0d6b1f2c9e11
                  name: r/programming new posts
                  endpoint: /v1/reddit/subreddit-posts
                  params:
                    url: https://www.reddit.com/r/programming/
                  interval_minutes: 60
                  webhook_url: https://example.com/hooks/captapi
                  active: true
                  next_run_at: '2026-10-10T19:00:00+00:00'
                  created_at: '2026-10-10T18:00:00+00:00'
                  secret: whsec_3b9f0c2d7a6e41f8b5c09d1e2a7f4c6b8d0e1f2a3b4c5d6e
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '404':
          $ref: '#/components/responses/Error404'
        '422':
          $ref: '#/components/responses/Error422'
        '429':
          $ref: '#/components/responses/Error429'
    patch:
      operationId: update_monitor
      tags:
      - Monitors
      summary: Update a monitor
      description: Change name, params, interval_minutes, webhook_url or active. Changing params resets the seen-items baseline so the next run does not flood your webhook. Free.
      security:
      - bearerAuth: []
      - apiKeyHeader: []
      parameters:
      - name: monitor_id
        in: path
        required: true
        schema:
          type: string
        example: 3f0c6a52-7f2e-4f4b-9a51-0d6b1f2c9e11
      x-credit-cost:
        label: 0 credits
        credits: 0
      x-one-liner: Change name, params, interval_minutes, webhook_url or active.
      responses:
        '200':
          description: Success.
          headers:
            X-Captapi-Credits:
              $ref: '#/components/headers/Credits'
            X-Captapi-Cache:
              $ref: '#/components/headers/Cache'
            X-Captapi-Request-Id:
              $ref: '#/components/headers/RequestId'
            Server-Timing:
              $ref: '#/components/headers/ServerTiming'
          content:
            application/json:
              schema:
                type: object
                required:
                - success
                - data
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      endpoint:
                        type: string
                      params:
                        type: object
                        properties:
                          url:
                            type: string
                      interval_minutes:
                        type: integer
                      webhook_url:
                        type: string
                      active:
                        type: boolean
                      next_run_at:
                        type: string
                      created_at:
                        type: string
              example:
                success: true
                data:
                  id: 3f0c6a52-7f2e-4f4b-9a51-0d6b1f2c9e11
                  name: r/programming new posts
                  endpoint: /v1/reddit/subreddit-posts
                  params:
                    url: https://www.reddit.com/r/programming/
                  interval_minutes: 60
                  webhook_url: https://example.com/hooks/captapi
                  active: true
                  next_run_at: '2026-10-10T19:00:00+00:00'
                  created_at: '2026-10-10T18:00:00+00:00'
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '404':
          $ref: '#/components/responses/Error404'
        '422':
          $ref: '#/components/responses/Error422'
        '429':
          $ref: '#/components/responses/Error429'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitorUpdate'
            example:
              interval_minutes: 120
              active: true
    delete:
      operationId: delete_monitor
      tags:
      - Monitors
      summary: Delete a monitor
      description: Deletes one of your monitors. Free.
      security:
      - bearerAuth: []
      - apiKeyHeader: []
      parameters:
      - name: monitor_id
        in: path
        required: true
        schema:
          type: string
        example: 3f0c6a52-7f2e-4f4b-9a51-0d6b1f2c9e11
      x-credit-cost:
        label: 0 credits
        credits: 0
      x-one-liner: Deletes one of your monitors.
      responses:
        '200':
          description: Success.
          headers:
            X-Captapi-Credits:
              $ref: '#/components/headers/Credits'
            X-Captapi-Cache:
              $ref: '#/components/headers/Cache'
            X-Captapi-Request-Id:
              $ref: '#/components/headers/RequestId'
            Server-Timing:
              $ref: '#/components/headers/ServerTiming'
          content:
            application/json:
              schema:
                type: object
                required:
                - success
                - data
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    properties:
                      deleted:
                        type: boolean
                      id:
                        type: string
              example:
                success: true
                data:
                  deleted: true
                  id: 3f0c6a52-7f2e-4f4b-9a51-0d6b1f2c9e11
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '404':
          $ref: '#/components/responses/Error404'
        '422':
          $ref: '#/components/responses/Error422'
        '429':
          $ref: '#/components/responses/Error429'
  /v1/monitors/{monitor_id}/test:
    post:
      operationId: test_monitor
      tags:
      - Monitors
      summary: Send a signed test payload to your webhook
      description: POSTs a signed monitor.test payload to the monitor's webhook_url so you can check signature verification. delivered is true when your server answered below 400. When the webhook cannot be reached at all (connection refused, DNS, TLS, or no answer within 15 seconds) the call returns 502 WEBHOOK_UNREACHABLE with retryable true. Free.
      security:
      - bearerAuth: []
      - apiKeyHeader: []
      parameters:
      - name: monitor_id
        in: path
        required: true
        schema:
          type: string
        example: 3f0c6a52-7f2e-4f4b-9a51-0d6b1f2c9e11
      x-credit-cost:
        label: 0 credits
        credits: 0
      x-one-liner: POSTs a signed monitor.test payload to the monitor's webhook_url so you can check signature verification.
      responses:
        '200':
          description: Success.
          headers:
            X-Captapi-Credits:
              $ref: '#/components/headers/Credits'
            X-Captapi-Cache:
              $ref: '#/components/headers/Cache'
            X-Captapi-Request-Id:
              $ref: '#/components/headers/RequestId'
            Server-Timing:
              $ref: '#/components/headers/ServerTiming'
          content:
            application/json:
              schema:
                type: object
                required:
                - success
                - data
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    properties:
                      delivered:
                        type: boolean
                      webhook_status:
                        type: integer
              example:
                success: true
                data:
                  delivered: true
                  webhook_status: 200
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '404':
          $ref: '#/components/responses/Error404'
        '422':
          $ref: '#/components/responses/Error422'
        '429':
          $ref: '#/components/responses/Error429'
components:
  schemas:
    MonitorCreate:
      properties:
        name:
          type: string
          maxLength: 120
          title: Name
          default: ''
        endpoint:
          type: string
          title: Endpoint
          description: Captapi GET path, e.g. /v1/reddit/subreddit-posts
        params:
          additionalProperties: true
          type: object
          title: Params
        interval_minutes:
          type: integer
          maximum: 1440
          minimum: 15
          title: Interval Minutes
          default: 60
        webhook_url:
          type: string
          title: Webhook Url
          description: HTTPS URL that receives new-item payloads
        secret:
          anyOf:
          - type: string
            maxLength: 128
            minLength: 16
          - type: 'null'
          title: Secret
          description: HMAC secret; generated if omitted
      type: object
      required:
      - endpoint
      - webhook_url
      title: MonitorCreate
    Error:
      type: object
      required:
      - success
      - error
      properties:
        success:
          const: false
        error:
          type: object
          required:
          - code
          - message
          - retryable
          properties:
            code:
              type: string
              description: Machine-readable error code, e.g. WRONG_RESOURCE_TYPE, NOT_FOUND, insufficient_credits, rate_limit_exceeded. Compare case-sensitively; both upper and lower case codes exist.
            message:
              type: string
              description: Human-readable explanation.
            retryable:
              type: boolean
              description: true when the same request may succeed later (429, most 5xx). Do not retry when false.
            suggestedEndpoint:
              type:
              - string
              - 'null'
              description: On platform mismatch, the endpoint that matches the URL you sent.
          additionalProperties: true
    MonitorUpdate:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Name
        params:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Params
        interval_minutes:
          anyOf:
          - type: integer
            maximum: 1440
            minimum: 15
          - type: 'null'
          title: Interval Minutes
        webhook_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Webhook Url
        active:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Active
      type: object
      title: MonitorUpdate
  responses:
    Error429:
      description: Rate limit reached. Wait for Retry-After seconds. Not billed.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error:
              code: rate_limit_exceeded
              message: rate limit exceeded
              retryable: true
              plan: starter
              limit_per_minute: 120
    Error422:
      description: A required parameter is missing or has the wrong type. Not billed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error:
              code: VALIDATION_ERROR
              message: Request validation failed. Fix the listed fields and retry.
              retryable: false
              issues:
              - type: missing
                loc:
                - query
                - url
                msg: Field required
                input: null
    Error404:
      description: The resource does not exist or is not public. Not billed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error:
              code: NOT_FOUND
              message: Monitor not found
              retryable: false
    Error401:
      description: Missing, invalid or revoked API key. Not billed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error:
              code: UNAUTHORIZED
              message: Invalid or revoked API key
              retryable: false
    Error400:
      description: 'Bad request: wrong platform URL, unknown endpoint, or an invalid parameter value. Not billed.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error:
              code: WRONG_RESOURCE_TYPE
              message: Expected a TikTok URL, but received a YouTube URL. Use the YouTube endpoint for that URL, or pass a TikTok URL like https://www.tiktok.com/@user/video/1234567890.
              retryable: false
              suggestedEndpoint: /v1/youtube/video-details
  headers:
    ServerTiming:
      description: 'Total time the request took, in milliseconds: `total;dur=<ms>`. No per-step breakdown.'
      schema:
        type: string
      example: total;dur=4387
    Cache:
      description: 1 when the response was served from the 24h cache, 0 otherwise.
      schema:
        type: string
        enum:
        - '0'
        - '1'
    RequestId:
      description: Request id. Include it when contacting support.
      schema:
        type: string
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
    Credits:
      description: Credits charged for this request. 0 on a free cache hit or a failed request.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `Authorization: Bearer capt_live_...`. Create one at https://captapi.com/dashboard/api-keys.'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Alternative to the bearer header: `X-API-Key: capt_live_...`.'
externalDocs:
  description: Docs
  url: https://captapi.com/docs