API Pública

Visão Geral

O Screvi oferece uma API REST pública para ler seus destaques e fontes de forma programática. Use-a para criar fluxos de trabalho personalizados, exportar dados para outras ferramentas ou construir suas próprias integrações.

Autenticação

Todas as requisições de API requerem uma chave de API passada no cabeçalho X-API-Key.

Obtendo Sua Chave de API

1. Vá para Configurações > API no aplicativo web do Screvi
2. Copie sua chave de API

Usando a Chave

Inclua a chave em cada requisição:

GET https://api.screvi.com/api/v1/highlights
X-API-Key: your-api-key-here

Limites de Taxa

• 100 requisições por minuto por chave de API
• Cabeçalhos de limite de taxa são incluídos nas respostas

Endpoints Disponíveis

Destaques

GET /api/v1/highlights

Busque seus destaques com paginação e filtros.

Parâmetros de consulta:

• page: Número da página (padrão: 1)
• limit: Resultados por página
• source_id: Filtrar por fonte
• favorite: Filtrar por favoritos (true/false)
• updated_since: Retornar apenas destaques atualizados após esta data

Fontes

GET /api/v1/sources

Busque suas fontes (livros, artigos, etc.) com paginação.

Documentação da API

A documentação completa e interativa da API está disponível em:

https://api.screvi.com/api/docs

Esta interface Swagger permite explorar todos os endpoints, ver esquemas de requisição/resposta e testar requisições diretamente.

Casos de Uso Exemplo

• Exportar destaques para um banco de dados Notion personalizado
• Construir um fluxo de trabalho Obsidian personalizado, ou usar o plugin oficial do Screvi para Obsidian para sincronizar seu cofre
• Criar um painel pessoal com estatísticas de leitura
• Automatizar fluxos de trabalho de publicação de destaques no Twitter/X
• Alimentar destaques na base de conhecimento de um assistente de IA