API pública

Usa a API REST da Semantika para consultar os dados do teu workspace de forma programática.

A API REST da Semantika permite consultar as marcas, métricas de visibilidade, prompts monitorizados e ações recomendadas do teu workspace.

Antes de começar

O acesso à API está disponível para workspaces elegíveis. Um administrador do workspace pode gerar e revogar a API key em Definições do workspace → API key.

Copia a API key no momento em que a geras e guarda-a num gestor de segredos. Por motivos de segurança, não volta a ser apresentada na plataforma.

URL base

Todos os pedidos usam a seguinte URL base:

https://app.semantika.pt/api/v1

Autenticação

Envia a API key no cabeçalho Authorization de cada pedido, no formato Bearer:

Authorization: Bearer sem_a_tua_api_key

Cada key está associada a um único workspace. A API devolve apenas dados desse workspace; se tentares consultar uma marca ou ação de outro workspace, o recurso não é encontrado.

Exemplo de pedido

curl --request GET \
  --url https://app.semantika.pt/api/v1/brands \
  --header 'Authorization: Bearer sem_a_tua_api_key'

Endpoints disponíveis

• Listar marcas
• Detalhe da marca
• Score de visibilidade
• Listar ações recomendadas
• Listar prompts monitorizados
• Detalhe de uma ação

Respostas e limites

Os endpoints devolvem JSON. Um pedido sem uma API key válida devolve 401; se o acesso à API não estiver disponível para o workspace, devolve 403.

São aplicados limites de pedidos para proteger o serviço. Para listas paginadas, consulta os parâmetros e metadados apresentados na referência de cada endpoint.