Criar um cliente
Cria a organização cliente com a marca do parceiro, põe o dono já dentro (sem aceite: conta existente entra direto e recebe aviso por e-mail; conta nova nasce confirmada e recebe o link de primeiro acesso) e instala as cópias dos agentes pedidos. `agents` aceita id ou apelido de agente do parceiro publicado para os clientes. Com `external_id`, repetir a chamada devolve 200 com o cliente que já existe, em vez de criar outro. Exige o escopo partner:write.
Authorization
chaveDeApi Chave de API da organização, criada nas configurações. Envie-a em Authorization: Bearer <sua chave>.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/partner/clients" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "owner": { "email": "user@example.com" } }'{ "client": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "slug": "string", "name": "string", "external_id": "string" }, "existing": true, "owner": { "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "email": "string", "created": true }, "agents": { "installed": [ { "ref": "string", "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978" } ], "failed": [ { "ref": "string", "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978" } ] }}Listar os clientes
Os clientes do parceiro, com os números agregados da tela de Clientes (pessoas, conversas em 30 dias, convite de dono pendente, cópias instaladas) e o `external_id` de cada um. Exige o escopo partner:read.
Consumo de um cliente
O consumo da organização cliente no período, só agregado: custo em dólares, tokens, requisições, conversas, contagem de pessoas ativas (sem a identidade de sistema e sem visitantes do chat embutido), a quebra por cópia gerenciada (pelo agente de origem), o resto somado sem nome, por modelo e por aplicação. Nenhuma pessoa, conversa, título ou trecho. Exige o escopo partner:read.