Introdução à API do Sinky Studio

A API do Sinky Studio permite integrar e orquestrar decisões inteligentes a partir de dados estruturados, documentos e inputs dinâmicos em seus fluxos de trabalho personalizados.

Você pode usar a API para interagir com diversos produtos da plataforma — como o Sinky Consulta, Sinky Studio, Sinky AI, entre outros — com o objetivo de automatizar decisões de crédito, compliance, KYC, fraude, portfólio e muito mais.

Toda entrada enviada via API é validada com base no esquema do fluxo configurado, processada pelas regras e integrações definidas no Studio, e retorna os resultados em uma resposta estruturada com variáveis, decisões e logs.

Modos de execução

O Sinky Studio oferece duas formas principais de iniciar workflows via API:

🔹 Execução única

Execute um fluxo com apenas um input por requisição, utilizando a rota:

👉 POST /studio/workflow/{workflowId}/start

Ideal para casos em tempo real, como solicitações individuais de crédito, validações cadastrais ou análises pontuais de risco.

🔹 Execução em lote

Envie múltiplos inputs na mesma requisição e processe um volume maior de decisões de forma paralela e otimizada, utilizando:

👉 POST /studio/workflow/{workflowId}/batch-start

Indicado para reprocessamentos, análises periódicas de portfólios ou decisões offline em escala.

Ambientes e Sandbox

Você pode testar sua integração com o Sinky Studio usando nosso ambiente de Sandbox, disponível diretamente na documentação:

👉 Acessar Sandbox do Sinky Studio API

No Sandbox, você encontrará exemplos de requisições e respostas, podendo simular execuções de workflow com dados reais ou fictícios.

Para obter credenciais de produção, entre em contato com o suporte da Sinky em:

📩 suporte@besinky.com

Recursos adicionais

Acesse os endpoints completos no menu lateral desta documentação;
Explore os exemplos de payloads, modelos de input e estrutura de resposta;
Utilize a ferramenta interativa integrada à doc para testar os fluxos;
Em breve: download da especificação OpenAPI (Swagger) da plataforma.