---
title: "Generate profiles"
method: POST
path: "/api/v1/business/profiles/generate"
tags: ["business"]
---

# Generate profiles

`POST /api/v1/business/profiles/generate`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/business/profiles/generate`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://auth.point11.ai/oauth2/authorize`, token URL `https://auth.point11.ai/oauth2/token`)

Research a new business profile, as a member or an API key with business:write, from one source: a website `url`, or a `description` of a subject with no website to start from (a person, practice, product or offering), each billed as one Profile interaction, or a `place`: a store of a brand business profile that has no place profile of its own yet (business_store_profiles_get_v2 answers its placeProfileId null), researched at the place its earlier research recorded, under the brand's current version, included at no charge and owing no forecast. A description takes optional attachmentIds of ready uploads that the opening research reads (a member's own; a key naming them is refused with user_required), and optionally the subjectMatch the member confirmed from business_profiles_check, which every research step reads with the words. A description and its files' names are screened for acceptable use first (business_profiles_check runs that screen without starting anything), and every refresh researches the same description and files. Returns the run; follow it with platform_runs_get_v2, then read it with business_profile_rows_list, or a store's with business_store_profiles_get_v2. A URL or store that already has a profile is refused with ALREADY_EXISTS: refresh that profile instead.

## Headers

- `Point11-Organization` string, uuid
- `Idempotency-Key` string, uuid, required

## Request body

- BusinessProfilesGenerateRequest
  - `url` string: The business's website URL; omit it to profile a description instead
  - `description` string: Who or what the profile is about, in the member's own words, for a subject with no website to start from: a person, practice, product or offering. Research identifies it from these words and any attached files.
  - `attachmentIds` string[]: Ids of ready uploads to attach to the description
  - `subjectMatch` object: With a description: the business_profiles_check match and the candidate the member confirmed, which every research step then reads with the words
    - `id` string, uuid, required: The match id business_profiles_check returned
    - `candidateIndex` integer, nullable, required: The chosen candidate's position in that match's candidates; null for none of them
  - `place` object: Instead of a website or a description: a store of a brand business profile with no place profile of its own yet, researched at the place its earlier research recorded
    - `profileId` string, uuid, required: The brand business profile the store is listed under
    - `locationKey` string, required: The store's location key, as business_store_profile_summaries_get lists it

## Response `202`

Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.

- BusinessProfilesGenerateResponse
  - `runId` string, uuid, required

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `402`: Billing refused the write: the code names the reason and `details.reason` carries it.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

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