---
title: "Run any tool by id"
method: POST
path: "/v1/run/{toolId}"
tags: ["account"]
---

# Run any tool by id

`POST /v1/run/{toolId}`

## Request

- Base URL: `https://chatterapi.com`
- URL: `https://chatterapi.com/v1/run/{toolId}`
- Auth: HTTP bearer

Generic alias for agents and SDKs: the body is the tool's arguments object. Costs what the tool costs.

## Path parameters

- `toolId` 'reddit.search' | 'reddit.nsfw_search' | 'reddit.search_comments' | 'reddit.search_media' | 'reddit.scrape' | 'reddit.thread' | 'reddit.communities' | 'reddit.nsfw_communities' | 'reddit.subreddit' | 'reddit.subreddit_posts' | 'reddit.user' | 'reddit.user_status' | 'reddit.user_comments' | 'reddit.user_posts' | 'reddit.user_search' | 'reddit.user_analysis' | 'reddit.leads' | 'x.user' | 'x.follow_check' | 'x.user_search' | 'x.followers' | 'x.following' | 'x.verified_followers' | 'x.tweets' | 'x.mentions' | 'x.search' | 'x.tweet_detail' | 'x.replies' | 'x.retweeters' | 'x.list_members' | 'x.leads' | 'x.dm_send' | 'x.follow' | 'x.like' | 'x.tweet' | 'everywhere.search' | 'everywhere.leads' | 'everywhere.mentions', required

## Request body

- object

## Response `200`

Success

- object
  - `data` unknown, required
  - `credits` Credits, required
    - `charged` integer, required
    - `remaining` integer, required
  - `requestId` string, required
  - `cached` boolean, required
  - `warnings` Warning[]
    - `code` 'partial_data' | 'stale_data' | 'platform_unavailable' | 'source_unavailable', required
    - `platform` 'reddit' | 'x'
    - `source` string
    - `fields` string[]

## Other responses

- `400`: Bad request: invalid_input
- `401`: Unauthorized: missing_key, invalid_key, key_revoked
- `402`: Payment required: insufficient_credits
- `403`: Forbidden: account_suspended, scope_denied
- `404`: Not found: not_found
- `429`: Too many requests: rate_limited
- `500`: Internal error: internal
- `502`: Bad gateway: upstream_error
- `504`: Gateway timeout: upstream_timeout

---

[API](https://skmtc.dev/chatterapi/apis/chatterapi-api.md) · [All operations](https://skmtc.dev/chatterapi/apis/chatterapi-api/llms.txt) · [OpenAPI document](https://skmtc.dev/chatterapi/apis/chatterapi-api/revisions/74036d6f908a?raw)