Pular para o conteúdo

Contexto da empresa, canvas por canvas

GET
/v1/company/context
curl --request GET \
--url https://developers.nexo.winningsales.com.br/v1/company/context \
--header 'Authorization: Bearer <token>'

Os sete canvases do contexto da empresa (empresa, ICP, persona, proposta de valor, posicionamento, oferta e prova), campo a campo, com a origem de cada campo e se a empresa já confirmou. É o mesmo contexto que o Nexo usa nas leituras; ler não consome IA.

Os sete canvases

Media typeapplication/json
object
reading
required

The latest site reading; null when none was requested yet

object
id
required

Reading id

string format: uuid
status
required

Status of the latest site reading

string
Allowed values: queued researching filling completed partial failed
failureKind
required

Ai_unavailable = try again; ai_rejected and budget = trying again does not help; unreadable = the answer came broken

string
nullable
Allowed values: ai_unavailable ai_rejected budget unreadable
siteUrl
required

Site that was read

string
nullable
finishedAt
required

ISO instant the reading finished

string
nullable
canvases
required
object
company
required

Empresa

object
canvas
required

The current canvas, field by field; null when nothing was ever read or confirmed

object
name
required

Official company name

object
value
required
string
<= 200 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
industry
required

The supplier’s own activity, never the industries it serves

object
value
required
string
<= 120 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
segment
required

Narrower description of the actual activity

object
value
required
string
<= 160 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
sizeSignal
required

Size of the company itself; set by rule from an explicit headcount, never guessed

object
value
required
string
Allowed values: startup sme mid-market enterprise unknown
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
description
required

2 to 4 sentences: what the company does and for whom

object
value
required
string
<= 800 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
brandVoice
required

Tone-of-voice descriptors, comma-separated

object
value
required
string
<= 400 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
website
required

Canonical site, or empty

object
value
required
string
<= 500 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
marketRegion
required

Explicit service coverage; a headquarters address is not coverage

object
value
required
string
<= 200 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
resonantWords
required

Words the brand and buyers lean into

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
frictionWords
required

Words that sound off-brand or create friction

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
pov
required

Points of view the brand publicly holds

object
value
required
Array<string>
<= 10 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
version
required

Version of the last confirmed canvas; null when it was never confirmed

integer
nullable
confirmedAt
required

ISO instant everything shown here was confirmed; null while it is a draft

string
nullable
state
required

Confirmed = every field is confirmed; draft = a new reading brought fields to confirm; empty = nothing yet

string
Allowed values: confirmed draft empty
editedFields
required

How many fields were written or approved by an admin

integer
icp
required

ICP

object
canvas
required

The current canvas, field by field; null when nothing was ever read or confirmed

object
industries
required

Customer industries

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
companySizeRange
required

Customer organization size; empty when unknown

object
value
required
string
<= 160 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
regions
required

Supported service coverage

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
buyingTriggers
required

Events that put these customers in market

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
exclusions
required

Explicit anti-fit only

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
qualificationSignals
required

Signs that a live opportunity fits

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
disqualificationSignals
required

Explicit conditions that make a live opportunity unsuitable

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
version
required

Version of the last confirmed canvas; null when it was never confirmed

integer
nullable
confirmedAt
required

ISO instant everything shown here was confirmed; null while it is a draft

string
nullable
state
required

Confirmed = every field is confirmed; draft = a new reading brought fields to confirm; empty = nothing yet

string
Allowed values: confirmed draft empty
editedFields
required

How many fields were written or approved by an admin

integer
persona
required

Persona

object
canvas
required

The current canvas, field by field; null when nothing was ever read or confirmed

object
personas
required
Array<object>
>= 1 items <= 3 items
object
label
required

Short, distinct, addressable handle

object
value
required
string
>= 1 characters <= 80 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
titles
required

Buying-role synonyms

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
responsibilities
required

What this person handles in relation to the offer

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
painPoints
required

Recurring friction the offer helps address

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
goals
required

Outcomes this audience seeks

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
decisionCriteria
required

Factors compared when choosing

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
objections
required

Plausible concerns that could delay the decision

object
value
required
Array<string>
<= 5 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
buyingTriggers
required

Typical “why now” situations

object
value
required
Array<string>
<= 5 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
valueAngle
required

The offer’s value through this persona’s needs

object
value
required
Array<string>
<= 4 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
channels
required

Plausible places to reach this audience

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
beliefs
required

Working assumptions shaping the choice

object
value
required
Array<string>
<= 6 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
fears
required

Risks this audience wants to avoid

object
value
required
Array<string>
<= 6 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
asksVsWants
required

A stated request paired with the underlying want

object
value
required
Array<string>
<= 6 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
version
required

Version of the last confirmed canvas; null when it was never confirmed

integer
nullable
confirmedAt
required

ISO instant everything shown here was confirmed; null while it is a draft

string
nullable
state
required

Confirmed = every field is confirmed; draft = a new reading brought fields to confirm; empty = nothing yet

string
Allowed values: confirmed draft empty
editedFields
required

How many fields were written or approved by an admin

integer
value-prop
required

Proposta de valor

object
canvas
required

The current canvas, field by field; null when nothing was ever read or confirmed

object
headline
required

One-sentence pitch

object
value
required
string
<= 280 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
problem
required

The customer-side difficulty

object
value
required
string
<= 800 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
solution
required

How the actual offer addresses it

object
value
required
string
<= 800 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
outcomes
required

Intended benefits, never guarantees

object
value
required
Array<string>
<= 15 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
differentiators
required

Supported features or delivery choices

object
value
required
Array<string>
<= 15 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
proofPoints
required

Only approved proof, near-verbatim

object
value
required
Array<string>
<= 6 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
version
required

Version of the last confirmed canvas; null when it was never confirmed

integer
nullable
confirmedAt
required

ISO instant everything shown here was confirmed; null while it is a draft

string
nullable
state
required

Confirmed = every field is confirmed; draft = a new reading brought fields to confirm; empty = nothing yet

string
Allowed values: confirmed draft empty
editedFields
required

How many fields were written or approved by an admin

integer
positioning
required

Posicionamento

object
canvas
required

The current canvas, field by field; null when nothing was ever read or confirmed

object
category
required

Category customers use to understand the offer

object
value
required
string
<= 200 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
frameOfReference
required

Alternatives and the status quo

object
value
required
string
<= 800 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
keyDifferentiator
required

The main reason to choose it

object
value
required
string
<= 800 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
targetMarket
required

Narrow description of who it is for

object
value
required
string
<= 800 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
competitors
required

Only competitors named verbatim in the sources

object
value
required
Array<string>
<= 15 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
version
required

Version of the last confirmed canvas; null when it was never confirmed

integer
nullable
confirmedAt
required

ISO instant everything shown here was confirmed; null while it is a draft

string
nullable
state
required

Confirmed = every field is confirmed; draft = a new reading brought fields to confirm; empty = nothing yet

string
Allowed values: confirmed draft empty
editedFields
required

How many fields were written or approved by an admin

integer
offer
required

Oferta

object
canvas
required

The current canvas, field by field; null when nothing was ever read or confirmed

object
offerings
required
Array<object>
<= 12 items
object
name
required

Offering name

object
value
required
string
<= 200 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
whatItIs
required

What is acquired

object
value
required
string
<= 800 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
deliverables
required

What the buyer receives

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
priceBand
required

Explicit price and unit; empty when unknown

object
value
required
string
<= 200 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
included
required

Scope explicitly included

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
timelineMechanism
required

Delivery or commitment clause, with its qualifiers

object
value
required
string
<= 400 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
outOfScope
required

Work explicitly not done

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
noFit
required

Buyer situations explicitly refused

object
value
required
Array<string>
<= 20 items
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
version
required

Version of the last confirmed canvas; null when it was never confirmed

integer
nullable
confirmedAt
required

ISO instant everything shown here was confirmed; null while it is a draft

string
nullable
state
required

Confirmed = every field is confirmed; draft = a new reading brought fields to confirm; empty = nothing yet

string
Allowed values: confirmed draft empty
editedFields
required

How many fields were written or approved by an admin

integer
proof
required

Prova

object
canvas
required

The current canvas, field by field; null when nothing was ever read or confirmed

object
items
required
Array<object>
<= 30 items
object
type
required

Narrowest supported proof type

object
value
required
string
Allowed values: case metric testimonial credential
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
content
required

Near-verbatim claim from the source

object
value
required
string
>= 1 characters <= 800 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
attribution
required

Explicit customer, publication or certifier

object
value
required
string
<= 400 characters
origin
required

Where this field currently stands: site, suggested, confirmed, admin or empty

string
Allowed values: site suggested confirmed admin empty
candidates
required

Open disambiguation only

Array<string>
approved
required

Always false until a person approves it

boolean
version
required

Version of the last confirmed canvas; null when it was never confirmed

integer
nullable
confirmedAt
required

ISO instant everything shown here was confirmed; null while it is a draft

string
nullable
state
required

Confirmed = every field is confirmed; draft = a new reading brought fields to confirm; empty = nothing yet

string
Allowed values: confirmed draft empty
editedFields
required

How many fields were written or approved by an admin

integer

Example

{
"reading": {
"status": "queued",
"failureKind": "ai_unavailable"
},
"canvases": {
"company": {
"canvas": {
"name": {
"origin": "site"
},
"industry": {
"origin": "site"
},
"segment": {
"origin": "site"
},
"sizeSignal": {
"value": "startup",
"origin": "site"
},
"description": {
"origin": "site"
},
"brandVoice": {
"origin": "site"
},
"website": {
"origin": "site"
},
"marketRegion": {
"origin": "site"
},
"resonantWords": {
"origin": "site"
},
"frictionWords": {
"origin": "site"
},
"pov": {
"origin": "site"
}
},
"state": "confirmed"
},
"icp": {
"canvas": {
"industries": {
"origin": "site"
},
"companySizeRange": {
"origin": "site"
},
"regions": {
"origin": "site"
},
"buyingTriggers": {
"origin": "site"
},
"exclusions": {
"origin": "site"
},
"qualificationSignals": {
"origin": "site"
},
"disqualificationSignals": {
"origin": "site"
}
},
"state": "confirmed"
},
"persona": {
"canvas": {
"personas": [
{
"label": {
"origin": "site"
},
"titles": {
"origin": "site"
},
"responsibilities": {
"origin": "site"
},
"painPoints": {
"origin": "site"
},
"goals": {
"origin": "site"
},
"decisionCriteria": {
"origin": "site"
},
"objections": {
"origin": "site"
},
"buyingTriggers": {
"origin": "site"
},
"valueAngle": {
"origin": "site"
},
"channels": {
"origin": "site"
},
"beliefs": {
"origin": "site"
},
"fears": {
"origin": "site"
},
"asksVsWants": {
"origin": "site"
}
}
]
},
"state": "confirmed"
},
"value-prop": {
"canvas": {
"headline": {
"origin": "site"
},
"problem": {
"origin": "site"
},
"solution": {
"origin": "site"
},
"outcomes": {
"origin": "site"
},
"differentiators": {
"origin": "site"
},
"proofPoints": {
"origin": "site"
}
},
"state": "confirmed"
},
"positioning": {
"canvas": {
"category": {
"origin": "site"
},
"frameOfReference": {
"origin": "site"
},
"keyDifferentiator": {
"origin": "site"
},
"targetMarket": {
"origin": "site"
},
"competitors": {
"origin": "site"
}
},
"state": "confirmed"
},
"offer": {
"canvas": {
"offerings": [
{
"name": {
"origin": "site"
},
"whatItIs": {
"origin": "site"
},
"deliverables": {
"origin": "site"
},
"priceBand": {
"origin": "site"
},
"included": {
"origin": "site"
},
"timelineMechanism": {
"origin": "site"
}
}
],
"outOfScope": {
"origin": "site"
},
"noFit": {
"origin": "site"
}
},
"state": "confirmed"
},
"proof": {
"canvas": {
"items": [
{
"type": {
"value": "case",
"origin": "site"
},
"content": {
"origin": "site"
},
"attribution": {
"origin": "site"
}
}
]
},
"state": "confirmed"
}
}
}

Token ausente, inválido, expirado ou revogado

Media typeapplication/json
object
type
required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string
title
required

Error class name

string
status
required

HTTP status code

integer
detail
required

Human-readable message, safe to display to end users

string
requestId
required

Correlation id — send it to support to locate the full trail

string
nullable
meta

Structured details safe for the frontend (field errors, ids)

object
key
additional properties

Example

{
"type": "public_api.invalid_credential",
"title": "InvalidCredentialError",
"status": 401,
"detail": "Token de acesso inválido, expirado ou revogado. Crie um novo token de acesso no Nexo.",
"requestId": "019fcae7-3e54-755a-8458-bdb605b324bb"
}

Papel, escopo do token ou plano não permitem a operação

Media typeapplication/json
object
type
required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string
title
required

Error class name

string
status
required

HTTP status code

integer
detail
required

Human-readable message, safe to display to end users

string
requestId
required

Correlation id — send it to support to locate the full trail

string
nullable
meta

Structured details safe for the frontend (field errors, ids)

object
key
additional properties

Example

{
"type": "public_api.insufficient_scope",
"title": "InsufficientScopeError",
"status": 403,
"detail": "Este token não tem o escopo conversations:read, exigido por esta operação. Gere um token com esse escopo.",
"requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
"meta": {
"operation": "conversations.reading",
"scope": "conversations:read"
}
}

Limite de chamadas da empresa ou do token atingido

Media typeapplication/json
object
type
required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string
title
required

Error class name

string
status
required

HTTP status code

integer
detail
required

Human-readable message, safe to display to end users

string
requestId
required

Correlation id — send it to support to locate the full trail

string
nullable
meta

Structured details safe for the frontend (field errors, ids)

object
key
additional properties

Example

{
"type": "public_api.rate_limited",
"title": "PublicRateLimitedError",
"status": 429,
"detail": "Muitas chamadas em pouco tempo. Tente de novo em 12 segundos.",
"requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
"meta": {
"class": "content",
"limitedBy": "company",
"limit": 120,
"windowSeconds": 60,
"retryAfterSeconds": 12
}
}