orgnaizations

Replace the organization's brand context for AI

The brand context every AI plan of this organization starts from: what the business does, who it talks to, the tone, what must never appear.

It replaces the whole context, it is not a patch. A field you leave out is erased, and an empty body removes the context entirely — after which plans run on their own prompt alone.

There is no GET: the current context already travels inside the organization object, in ai_context.

put/organizations/{id_organization}/ai-context

Request

  • Base URL: https://api.planvortex.com/v1.0.0
  • URL: https://api.planvortex.com/v1.0.0/organizations/{id_organization}/ai-context
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.planvortex.com/v1.0.0/oauth/token)

Path parameters

id_organizationstring required

Organization identifier

Request body

brand_namestring

Commercial name, when it differs from the organization's.

descriptionstring

What the organization does.

sectorstring
audiencestring

Who the content is aimed at.

value_propositionstring
websitestring
shop_urlstring
blog_urlstring
social_urlsstring[]

Social profiles or other reference links.

default_tonestring

Default tone. A tone set on the plan itself wins over this one.

keywordsstring[]

Recurring keywords and hashtags.

productsstring

Products or services that may be promoted.

avoidstring

Topics, expressions or competitors that must never appear.

notesstring

Anything else the model should know.

Response

The organization with its new context

Example response

{
  "organization": {
    "_id": "66d04a6a427f4c43b9d97f54"
  }
}

Changes

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