---
title: "Read your website and plan searches"
method: POST
path: "/v1/site-profile"
tags: ["Account"]
---

# Read your website and plan searches

`POST /v1/site-profile`

## Request

- Base URL: `https://api.nvoke.run`
- URL: `https://api.nvoke.run/v1/site-profile`
- Auth: HTTP bearer

Reads your homepage and its about, pricing and services pages (robots.txt honored), then Claude writes the profile and suggests 3 to 6 searches. Each suggestion holds a `search` body you can send to `POST /v1/searches` as is. Replaces the stored profile. Free, 10 a day per account. Takes about 20 seconds.

## Request body

- object
  - `website` string, required

## Response `200`

OK

- object
  - `website` string, required
  - `domain` string, required
  - `profile` object, required
    - `name` string, required
    - `summary` string, required
    - `offer` string, required
    - `audience` string, required
    - `proofPoints` string[], required
    - `voice` string[], required
    - `language` unknown, required
    - `country` unknown, required
  - `suggestions` object[], required
    - `why` string, required
    - `search` union, required
      - object
        - `kind` 'local', required
        - `params` object, required
          - `niche` string, required
          - `location` string, required
        - `limit` integer
        - `checkInboxes` boolean
      - object
        - `kind` 'web', required
        - `params` object, required
          - `keyword` string, required
          - `country` unknown
        - `limit` integer
        - `checkInboxes` boolean
      - object
        - `kind` 'launches', required
        - `params` object, required
          - `keyword` string
          - `days` integer, required
          - `sources` string[]
        - `limit` integer
        - `checkInboxes` boolean
      - object
        - `kind` 'domains', required
        - `params` object, required
          - `items` unknown, required
          - `country` unknown
        - `limit` integer
        - `checkInboxes` boolean
      - object
        - `kind` 'icp', required
        - `params` object, required
          - `description` string, required
          - `product` string
          - `countries` unknown[]
            - unknown
          - `locations` string[]
        - `limit` integer
        - `checkInboxes` boolean
  - `pages` string[], required
  - `icon` string, nullable, required
  - `image` string, nullable, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

## Other responses

- `4XX`: `unauthorized`: No valid token. Send `Authorization: Bearer <key>`. `invalid_request`: The body or query failed validation. `details` lists the problems. `site_unreadable`: We could not read the website: it is down, robots.txt keeps us out, it refuses our servers or it needs JavaScript. `detail` says which. `rate_limited`: Too many requests of this kind from this account or client. Try again later. `ai_unavailable`: Claude could not answer right now, or the account spent its monthly Claude budget. Try again later.

## Changes

- **2026-10-20** `f7cfd26111a8`: 1 breaking, 1 info
  - added `subschema #1, subschema #2, subschema #3, subschema #4, subschema #5` to the `suggestions/items/search` response property `oneOf` list for the response status `200`
  - removed `subschema #1, subschema #2, subschema #3, subschema #4, subschema #5` from the `suggestions/items/search` response property `oneOf` list for the response status `200`

[Operation history](https://skmtc.dev/nvoke/apis/nvoke-api/changes/v1/site-profile/post.md)

---

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