HTTPS quickstart

curl --request POST 'https://inference.scrapist.bot/private/ai_name' \
  --header "Authorization: Bearer ${SCRAPIST_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{
    "event": {
      "id": "post_1938475629102848123",
      "text": "A new trading terminal is launching today."
    }
  }'

const response = await fetch(
  "https://inference.scrapist.bot/private/ai_name",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.SCRAPIST_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      event: {
        id: "post_1938475629102848123",
        text: "A new trading terminal is launching today.",
      },
    }),
  },
);

const body = await response.json();
if (!response.ok) throw new Error(`${body.error.code}: ${body.error.message}`);

{
  "name": "Terminal Launch",
  "ticker": "TERM"
}

curl --request POST 'https://inference.scrapist.bot/private/ai_name' \
  --header "Authorization: Bearer ${SCRAPIST_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{
    "event": {
      "id": "post_1938475629102848123",
      "text": "A new trading terminal is launching today."
    }
  }'

const response = await fetch(
  "https://inference.scrapist.bot/private/ai_name",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.SCRAPIST_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      event: {
        id: "post_1938475629102848123",
        text: "A new trading terminal is launching today.",
      },
    }),
  },
);

const body = await response.json();
if (!response.ok) throw new Error(`${body.error.code}: ${body.error.message}`);

{
  "name": "Terminal Launch",
  "ticker": "TERM"
}

Choose an endpoint, send its small JSON body, and wait for one response. The interactive API reference in the navigation can generate cURL, JavaScript, and Python requests for all five operations.

Prerequisites

An assigned key from the Scrapist dashboard.
A server-side application or trusted server shell.

export SCRAPIST_API_KEY="<SCRAPIST_API_KEY>"

Generate an AI name

AI Name is the only route that accepts social text and event context.

curl --request POST 'https://inference.scrapist.bot/private/ai_name' \
  --header "Authorization: Bearer ${SCRAPIST_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{
    "event": {
      "id": "post_1938475629102848123",
      "text": "A new trading terminal is launching today."
    }
  }'

const response = await fetch(
  "https://inference.scrapist.bot/private/ai_name",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.SCRAPIST_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      event: {
        id: "post_1938475629102848123",
        text: "A new trading terminal is launching today.",
      },
    }),
  },
);

const body = await response.json();
if (!response.ok) throw new Error(`${body.error.code}: ${body.error.message}`);

{
  "name": "Terminal Launch",
  "ticker": "TERM"
}

Scrapist returns exactly one generated name and ticker. It does not translate the name or include follow-up search results.

Search past coins

Past Coins accepts exactly one search term per request. Set providers to a non-empty array containing solana, robinhood, or both. Omitting it defaults to ["solana"].

curl --request POST 'https://inference.scrapist.bot/private/past_coins' \
  --header "Authorization: Bearer ${SCRAPIST_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{
    "requestId": "req_past_coins_01",
    "query": "Terminal Launch",
    "providers": ["solana"]
  }'

type PastCoinsProvider = "solana" | "robinhood";

async function searchPastCoins(
  query: string,
  providers: PastCoinsProvider[] = ["solana"],
) {
  const response = await fetch(
    "https://inference.scrapist.bot/private/past_coins",
    {
      method: "POST",
      headers: {
        Authorization: `Bearer ${process.env.SCRAPIST_API_KEY}`,
        "Content-Type": "application/json",
      },
      body: JSON.stringify({ query, providers }),
    },
  );

  const body = await response.json();
  if (!response.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
  return body;
}

const providers: PastCoinsProvider[] = ["solana", "robinhood"];
const nameResult = await searchPastCoins("Terminal Launch", providers);
const pastCoins = nameResult.results.length
  ? nameResult
  : await searchPastCoins("TERM", providers);

{
  "requestId": "req_past_coins_01",
  "query": "Terminal Launch",
  "providers": ["solana"],
  "results": []
}

The server does not accept fallbackQuery. To fall back from a generated name to its ticker, inspect the first response and send a second request only when results is empty.

Call an image route

Crops and OCR accept only requestId and images. They reject text, event, eventStage, and tags.

curl --request POST 'https://inference.scrapist.bot/private/crops' \
  --header "Authorization: Bearer ${SCRAPIST_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{
    "images": ["https://assets.example.com/posts/terminal-1.png"]
  }'

curl --request POST 'https://inference.scrapist.bot/private/ocr' \
  --header "Authorization: Bearer ${SCRAPIST_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{
    "images": ["https://assets.example.com/posts/terminal-1.png"]
  }'

You may use X-Api-Key: <SCRAPIST_API_KEY> instead of bearer authentication.

Edit an image

Image Edit accepts a prompt, up to three images, and an optional requestId. Each image is a public http(s) URL or a base64 data:image/...;base64, URL. Omit images to draw on a blank white canvas.

curl --request POST 'https://inference.scrapist.bot/private/image_edit' \
  --header "Authorization: Bearer ${SCRAPIST_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{
    "requestId": "req_image_edit_01",
    "prompt": "Change the red jacket to a blue hoodie. Keep the face and background unchanged.",
    "images": ["https://assets.example.com/posts/terminal-1.png"]
  }'

import { writeFile } from "node:fs/promises";

const response = await fetch(
  "https://inference.scrapist.bot/private/image_edit",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.SCRAPIST_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      prompt:
        "Change the red jacket to a blue hoodie. Keep the face and background unchanged.",
      images: ["https://assets.example.com/posts/terminal-1.png"],
    }),
  },
);

const body = await response.json();
if (!response.ok) throw new Error(`${body.error.code}: ${body.error.message}`);

const [, base64] = body.images[0].split(",");
await writeFile("edited.jpg", Buffer.from(base64, "base64"));

{
  "requestId": "req_image_edit_01",
  "images": ["data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD..."]
}

The edited image is one 512x512 JPEG. Image Edit has its own per-minute limit, separate from your RPM limit.

Choose the operation

Endpoint	Request data	Response data
`POST /private/ai_name`	One `event`	One `name` and `ticker`
`POST /private/past_coins`	One `query`, optional `requestId` and `providers`	Matching past coins
`POST /private/crops`	`images`, optional `requestId`	Per-image crop rectangles
`POST /private/ocr`	`images`, optional `requestId`	Per-image text and lines
`POST /private/image_edit`	One `prompt`, optional `images` and `requestId`	One edited JPEG

See AI Name input, result shapes, and errors and limits.

Get started

API reference

Reference

Prerequisites

Generate an AI name

Search past coins

Call an image route

Edit an image

Choose the operation

​Prerequisites

​Generate an AI name

​Search past coins

​Call an image route

​Edit an image

​Choose the operation

Prerequisites

Generate an AI name

Search past coins

Call an image route

Edit an image

Choose the operation