business

Generate profiles

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.

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)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

urlstring

The business's website URL; omit it to profile a description instead

descriptionstring

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.

attachmentIdsstring[]

Ids of ready uploads to attach to the description

Response

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

runIdstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.