Pular para o conteúdo
Documentation

Referência ao endpoint do serviço

Todos os caminhos nesta página são relativos a:

https://api.champrep.com

Utilize uma credencial de portador com escopo, conforme descrito em autenticação e APIchaves. Uma rota listada ainda está sujeita à disponibilidade atual do serviço, às configurações do plano e da organização, às permissões de função, ao acesso aos recursos e aos controles de uso em tempo real.

ÁreaPrefixoÂmbitos
Identidade e perfil/v1/auth, /v1/usersusers:read e contexto de credenciais
Pesquise em todos os serviços/v1/searchO escopo de leitura de cada serviço pesquisado
Drive/v1/drivedrive:read, drive:write, drive:delete
Chat/v1/chatchat:read, chat:write
Calendar/v1/calendarcalendar:read, calendar:write
Contacts/v1/contactscontacts:read, contacts:write
Meet/v1/meetmeet:read, meet:write
Notes/v1/notesnotes:read, notes:write
Planilhas/v1/sheetssheets:read, sheets:write, sheets:share, sheets:delete, sheets:export
Documentos/passthrough/docsdocs:read, docs:write, docs:share, docs:delete, docs:export
Learn/v1/learn, /v1/coursescourses:read, courses:write
CHAMPREP AI/v1/aiai:chat
Mail/v1/mailmail:read, mail:write, mail:send
Work/v1/workwork:read, work:write, work:delete
Org Chart/v1/chartscharts:read, charts:write, charts:delete
Forms/v1/formsforms:read, forms:write
Invoice/v1/invoiceinvoice:read, invoice:write, invoice:send, invoice:delete
CHAMPREP QA/v1/qaqa:read, qa:write
CHAMPREP Code/passthrough/codecode: escopos, consulte CHAMPREP Código
Fazenda de Executores/passthrough/runner-farmrunner_farm:read, runner_farm:write
CHAMPREP Business/v1/businessbusiness:read, business:manage
Faturamento/v1/billingbilling:read, billing:manage
Webhooks/v1/webhookswebhooks:manage

GET, HEAD, e OPTIONS normalmente exigem o escopo de leitura. Os métodos de criação, atualização e ação exigem o escopo de gravação ou gerenciamento. Os métodos de exclusão exigem um escopo de exclusão, caso o serviço o defina. Uma rota pode exigir permissões adicionais de função ou recurso no serviço de destino.

MétodoCaminhoObjetivo
GET/v1/versionRetornar informações sobre a versão pública do Gateway.
GET/v1/auth/whoamiRetornar o contexto do usuário ativo, do perfil, das credenciais e do plano.
GET/v1/auth/quotaRetornar a chave atual e o instantâneo da cota do Gateway.
GET/v1/users/meRetornar o perfil do usuário atual.
GET/v1/users/me/notificationsListar as notificações visíveis ao usuário atual.

A trocaCLI assistida pelo navegador também utiliza /v1/auth/cli/start, /v1/auth/cli/device, e /v1/auth/cli/poll. Essas rotas são implementadas pelo aplicativo oficialCLI; aplicativos personalizados não devem imitar o protocolo de aprovaçãoCLI quando uma chaveAPI atender às suas necessidades.

MétodoCaminhoEscopoObjetivo
GET/v1/searchPor serviço, veja abaixoPesquise todos os serviços aos quais esta credencial tem acesso, em uma única chamada.
GET/v1/search/servicesNenhumListe quais serviços esta credencial é capaz de pesquisar.

/v1/search distribui a solicitação pelos serviços que suportam a pesquisa e mescla os resultados. Parâmetros:

ParâmetroPadrãoObjetivo
qobrigatórioO termo de pesquisa.
limit5Número máximo de resultados por serviço, até 20.
servicestodosLista separada por vírgulas, por exemplo mail,drive. Isso reduz a dispersão.
semanticfalseDefinir true para reclassificar os resultados com IA e obter uma resposta breve. Gasta seus próprios créditos de IA.

semantic=true adiciona uma verificação de IA aos resultados que você já possui: ela analisa sua pergunta, reordena as correspondências de acordo com a qualidade da resposta, acrescenta uma breve justificativa a cada uma e retorna um parágrafo answer.

O serviço é pago com seus próprios créditos de IA — a mesma cota mensal que o CHAMPREP AIassistente utiliza. Nada é cobrado a menos que você solicite, e a pesquisa por palavra-chave nunca consome créditos de IA.

Cada resposta informa o que ocorreu em semantic:

"semantic": { "requested": true, "applied": true, "answer": "..." }

Quando a verificação de IA não puder ser executada, os resultados das palavras-chave serão exibidos sem alterações e semantic explica o motivo:

reasonSignificado
AI_CREDITS_EXHAUSTEDVocê esgotou seus créditos mensais de IA.
PLAN_NO_AISeu plano não inclui o serviço de IA.
AI_UNAVAILABLENão foi possível acessar o serviço de IA neste momento.

Uma tentativa de IA malsucedida nunca impede a pesquisa. Ligue /v1/search/services primeiro para verificar se a pesquisa inteligente está disponível — ela retorna semantic.available além dos seus créditos restantes — e oculte a opção de IA quando ela não estiver disponível.

Um serviço só é incluído quando a credencial possui permissão de leitura para ele (mail:read, drive:read, notes:read, calendar:read, chat:read, work:read, invoice:read, contacts:read) e o plano ativo permite isso. Ambas as verificações falham em modo “fechado”, portanto, um serviço que você não pode usar nunca contribui com resultados.

Chat As mensagens são criptografadas em repouso e são pesquisadas apenas dentro das salas das quais você faz parte, no histórico recente, em vez de no arquivo completo.

Terminal window
curl -H "Authorization: Bearer $CHAMPREP_API_KEY" \
"https://api.champrep.com/v1/search?q=roadmap&services=mail,notes&limit=3"

Os resultados são agrupados por serviço e normalizados para um único formato, de modo que um cliente renderize todos os serviços da mesma maneira:

{
"success": true,
"data": {
"query": "roadmap",
"groups": [
{
"service": "notes",
"label": "Notes",
"results": [
{ "id": "6650...", "title": "Q3 roadmap", "subtitle": "Planning notes for...", "timestamp": "2026-08-02T10:14:00Z" }
]
}
],
"totalResults": 1,
"searched": ["notes", "mail"],
"skipped": [{ "service": "drive", "reason": "INSUFFICIENT_SCOPE" }],
"cost": 2
}
}

Leia skipped antes de tratar um resultado vazio como “nada encontrado”. Cada entrada explica por que um serviço foi deixado de fora — INSUFFICIENT_SCOPE, NOT_IN_PLAN, ou SERVICE_UNAVAILABLE quando um back-end estava muito lento ou temporariamente indisponível. Um serviço indisponível nunca faz com que toda a consulta falhe; o restante dos resultados ainda é retornado.

Uma pesquisa acessa um serviço por grupo de resultados, portanto é cobrada dessa forma: uma unidade de limite de taxa por serviço efetivamente pesquisado. O cost O campo em cada resposta informa exatamente o que foi cobrado e X-RateLimit-Remaining reflete isso antes de você receber a resposta.

SolicitaçãoServiços pesquisadosCusto
?q=roadmap em um plano com todos os oito88
?q=roadmap&services=mail11
?q=roadmap em um plano com apenas Notes11

Você nunca é cobrado por um serviço que não pode utilizar; portanto, restringir a pesquisa com services é a maneira mais econômica de manter uma pesquisa interativa ágil. Sempre aplique o debounce — nunca envie uma solicitação a cada tecla pressionada.

MétodoCaminhoEscopoObjetivo
GET/v1/drive/filesdrive:readListar ou pesquisar arquivos. Utilize o search Consulte quando necessário.
GET/v1/drive/foldersdrive:readListar o conteúdo da pasta raiz.
GET/v1/drive/folders/{folderId}drive:readListar o conteúdo de uma pasta.
GET/v1/drive/starreddrive:readListar itens marcados com estrela.
GET/v1/drive/recentdrive:readListar itens recentes.
GET/v1/drive/shareddrive:readListar itens compartilhados.
GET/v1/drive/quotadrive:readRetornar o uso atual do armazenamento e a disponibilidade.
POST/v1/drive/uploaddrive:writeCriar um destino de upload.
POST/v1/drive/filesdrive:writeSalvar os metadados do arquivo após o upload ser concluído com sucesso.
POST/v1/drive/downloaddrive:readCrie um link de download de curta duração vinculado à credencial de chamada.
GET/v1/drive/content/{token}drive:readTransmita um link emitido por /v1/drive/download.
POST/v1/drive/foldersdrive:writeCriar uma pasta.
POST/v1/drive/renamedrive:writeMover ou renomear um item.
POST/v1/drive/deletedrive:deleteExcluir um ou mais itens.
DELETE/v1/drive/files/{fileId}drive:deleteExcluir um arquivo por meio do método legado de item único.

Os downloads ocorrem em duas etapas: POST /v1/drive/download retorna um url no gateway que funciona apenas para a chaveAPI ou sessão que o solicitou, até que expiresInSeconds expirar. Recupere-o com o mesmo Authorization cabeçalho; o link não é utilizável por si só.

O upload é uma operação em várias etapas: solicitar um destino de upload, transferir os bytes para esse destino e salvar os metadados resultantes. Utilize o CLIquando não for necessário implementar essa sequência por conta própria.

MétodoCaminhoEscopoObjetivo
GET/v1/chat/roomschat:readListar salas visíveis para o perfil ativo.
GET/v1/chat/rooms/{roomId}chat:readLer uma sala.
POST/v1/chat/roomschat:writeCriar uma sala.
GET/v1/chat/rooms/{roomId}/messageschat:readListar mensagens da sala.
POST/v1/chat/rooms/{roomId}/messageschat:writeEnviar uma mensagem para a sala.
GET/v1/chat/messages/searchchat:readPesquisar mensagens.
GET/v1/chat/unreadchat:readRetornar contagens de itens não lidos.
GET/v1/chat/favoriteschat:readListar mensagens favoritas.
MétodoCaminhoEscopoObjetivo
GET/v1/calendar/eventscalendar:readListar eventos; suporta startDate e endDate consultas.
GET/v1/calendar/events/{eventId}calendar:readLer um evento.
POST/v1/calendar/eventscalendar:writeCriar um evento.
PATCH/v1/calendar/events/{eventId}calendar:writeAtualizar um evento.
DELETE/v1/calendar/events/{eventId}calendar:writeExcluir um evento.
GET/v1/calendar/upcomingcalendar:readListar reuniões futuras.
GET/v1/calendar/invitationscalendar:readListar convites pendentes.

Envie carimbos de data/hora de eventos no formato ISO 8601 com um fuso horário explícito. A criação e as atualizações de eventos consomem a cota configurada para o plano ativo e a organização; o APInão define um limite fixo universal para o plano.

MétodoCaminhoEscopoObjetivo
GET/v1/contactscontacts:readListar contatos.
GET/v1/contacts/searchcontacts:readPesquisar contatos com q ou email.
GET/v1/contacts/favoritescontacts:readListar favoritos.
GET/v1/contacts/labelscontacts:readListar rótulos.
GET/v1/contacts/{contactId}contacts:readLer um contato.
POST/v1/contactscontacts:writeAdicionar um contato.
PUT/v1/contacts/{contactId}contacts:writeAtualizar os metadados de contato.
DELETE/v1/contacts/{contactId}contacts:writeExcluir um contato.
MétodoCaminhoEscopoObjetivo
GET/v1/meet/roomsmeet:readListar salas de reunião.
GET/v1/meet/rooms/{roomId}meet:readLer uma sala.
POST/v1/meet/roomsmeet:writeCriar uma sala.
GET/v1/meet/sessionsmeet:readListar sessões de reunião.
GET/v1/meet/sessions/{sessionId}/participantsmeet:readListar os participantes da sessão.
GET/v1/meet/recordingsmeet:readListar as gravações disponíveis.
GET/v1/meet/transcriptionsmeet:readListar transcrições.
GET/v1/meet/transcriptions/{sessionId}meet:readLer a transcrição de uma sessão final.
GET/v1/meet/usagemeet:readRetornar o uso atual da reunião.

O acesso a gravações e transcrições depende da propriedade da reunião, do consentimento, da retenção, do plano e da política da organização.

MétodoCaminhoEscopoObjetivo
GET/v1/notesnotes:readListar notas.
GET/v1/notes/sharednotes:readListar notas compartilhadas com o perfil ativo.
GET/v1/notes/{noteId}notes:readLer uma nota.
POST/v1/notesnotes:writeCriar uma nota.
PATCH/v1/notes/{noteId}notes:writeAtualizar uma nota.
DELETE/v1/notes/{noteId}notes:writeExcluir uma nota.
POST/v1/notes/{noteId}/sharenotes:writeCompartilhar uma nota utilizando as configurações de acesso compatíveis.

/v1/learn e /v1/courses expor as mesmas rotas de cursos selecionadas.

MétodoCaminhoEscopoObjetivo
GET/v1/learncourses:readListar os cursos disponíveis.
GET/v1/learn/enrolled/mycourses:readListar as matrículas do usuário ativo.
GET/v1/learn/{courseId}courses:readLer um curso.
GET/v1/learn/{courseId}/sectionscourses:readListar seções do curso.
POST/v1/learncourses:writeCriar um curso quando a função o permitir.
PUT/v1/learn/{courseId}courses:writeAtualize um curso quando a função permitir.

Utilize o /v1/courses prefixo ao manter uma integração que já utilize esse alias.

MétodoCaminhoEscopoObjetivo
POST/v1/ai/chatai:chatEnvie um prompt ou uma carga útil de conversa compatível.
GET/v1/ai/conversationsai:chatListar conversas salvas.
GET/v1/ai/conversations/{conversationId}ai:chatLer uma conversa.
DELETE/v1/ai/conversations/{conversationId}ai:chatExcluir uma conversa.
GET/v1/ai/usageai:chatRetornar o uso atual de IA.

A saída da IA pode estar incompleta ou incorreta. Revise as saídas importantes e não envie dados que o usuário ativo não esteja autorizado a divulgar.

MétodoCaminhoEscopoObjetivo
GET/v1/mail/accountsmail:readListar contas de e-mail conectadas.
GET/v1/mail/emailsmail:readListar mensagens.
GET/v1/mail/emails/{emailId}mail:readLer uma mensagem.
GET/v1/mail/threadsmail:readListar threads.
GET/v1/mail/threads/{threadId}mail:readLer um tópico.
POST/v1/mail/sendmail:sendEnviar uma mensagem.
GET/v1/mail/domainsmail:readListar domínios de e-mail visíveis.

A interface GatewayWork reflete a versão compatível de abaixoWorkAPI de /v1/work. O Gateway determina o escopo necessário a partir do método HTTP:

  • Os métodos de leitura exigem work:read.
  • Os métodos de criação e atualização exigem work:write.
  • Os métodos de exclusão e as ações destrutivas em massa ou de cancelamento de importação exigem work:delete.

As rotas comuns incluem:

MétodoCaminhoObjetivo
GET, POST/v1/work/boardsListar ou criar quadros.
GET, PUT, DELETE/v1/work/boards/{boardId}Ler, atualizar ou arquivar um quadro.
GET/v1/work/boards/{boardId}/kanbanLer a visualização Kanban do quadro.
GET/v1/work/boards/{boardId}/export/csvExportar um quadro como CSV.
GET/v1/work/boards/{boardId}/export/jsonExportar um instantâneo estruturado do quadro.
GET, POST/v1/work/ticketsPesquisar ou criar tickets.
GET, PUT, DELETE/v1/work/tickets/{ticketId}Ler, atualizar ou arquivar um ticket.
GET/v1/work/me/dashboardRetornar o resumo do painelWork ativo.
GET/v1/work/me/quotaRetornar o usoWork e os limites atuais do .
GET, POST/v1/work/import/jobsListar ou gerenciar tarefas de importação compatíveis.

Quadros, tickets, sprints, automações, importações, registros de tempo, comentários, anexos, visualizações salvas e associação ao espaço de trabalho continuam a aplicar suasWork funções e permissões de recursos após a verificação de escopo do Gateway.

A superfícieOrg Chart está disponível em /v1/charts. Os métodos de leitura exigem charts:read, os métodos de criação e atualização exigem charts:write, e os métodos de exclusão exigem charts:delete.

As rotas comuns incluem:

MétodoCaminhoObjetivo
GET/v1/charts/me/org-chartLeia o gráfico do usuário ativo.
GET/v1/charts/me/positionLeia a posição ativa do gráfico.
GET/v1/charts/me/connectionsLeia as conexões de relacionamento.
GET/v1/charts/me/suggestionsLeia as sugestões de relacionamento.
GET/v1/charts/users/searchPesquise usuários para relações de gráficos.
GET/v1/charts/orgs/{orgId}/chartLeia um gráfico organizacional.
PATCH/v1/charts/orgs/{orgId}/configAtualize a configuração do gráfico.
POST/v1/charts/orgs/{orgId}/chart/nodesCrie um nó de gráfico.
PATCH, DELETE/v1/charts/orgs/{orgId}/chart/nodes/{nodeId}Atualize ou exclua um nó.

O Gateway também expõe os seguintes prefixos de serviço versionados:

PrefixoEscopo de leituraEscopo de gravação ou açãoEscopo de exclusão
/v1/formsforms:readforms:write—
/v1/sheetssheets:read; as ações de exportação utilizam sheets:exportsheets:write; o compartilhamento e a publicação utilizam sheets:sharesheets:delete
/v1/invoiceinvoice:readinvoice:write; as ações de envio ou emissão utilizam invoice:sendinvoice:delete
/v1/qaqa:readqa:write—
/v1/businessbusiness:readbusiness:manage—
/v1/billingbilling:readbilling:manage—

Esses prefixos preservam o sufixo de recurso compatível por baixo do Gateway, ao mesmo tempo em que centralizam a autenticação, o acesso ao serviço, os escopos, os limites de taxa e o contexto de auditoria . Prefira uma rota explicitamente apresentada pelo serviço, em vez de adivinhar caminhos de recursos a partir do tráfego do navegador.

O faturamento é uma superfície do plano de controle. Ele permanece sujeito a API Gatewayacesso, limites de taxa e escopos de faturamento, mesmo quando um gateway de serviço de destino impediria um usuário de efetuar o pagamento ou realizar um upgrade.

CHAMPREP O Code, a Fazenda de Executores e o Docs são acessados por meio de um encaminhamento: o Gateway encaminha sua solicitação para a própria API REST desse serviço APIsob um caminho fixo, após as mesmas verificações de chave, limite de taxa, plano e escopo que qualquer outra rota. O caminho após o prefixo é o próprio caminhoAPI do serviço.

PrefixoEncaminhamentosExemplo
/passthrough/codeCHAMPREP APICaminhos do Code sob /v1/codeGET /passthrough/code/v1/code/projects
/passthrough/runner-farmCaminhosAPI da Fazenda de Executores sob /v1GET /passthrough/runner-farm/v1/pools
/passthrough/docsAPICaminhos de Docs sob /api/v1/docsGET /passthrough/docs/api/v1/docs/documents

Um caminho fora do namespace permitido retorna 404 NOT_FOUND. Apenas a credencial do próprio Gateway acessa o serviço: não envie tokens de serviço nos cabeçalhos ou em job_token, private_token, ou access_token parâmetros de consulta, pois o Gateway os remove.

  • GET, HEAD, e OPTIONS requerem pelo menos um code: escopo com permissão de leitura. Outros métodos requerem code:api ou um code:write_ escopo.
  • CHAMPREP O Code verifica então o escopo exato para cada endpoint, da mesma forma que verifica um token de acesso pessoal. Por exemplo, a leitura de arquivos do repositório requer code:read_repository, code:read_api, ou code:api.
  • Caminhos sob /v1/code/admin requerem uma chave que contenha code:admin_mode por nome e uma conta que seja administradora do Code. O curinga e code:api não têm acesso a eles.

  • Os métodos de leitura exigem runner_farm:read. Outros métodos requerem runner_farm:write.
  • Uma chave nunca acessa segredos de conectores, tokens de executores, a verificação de tokens, o emparelhamento ou os próprios pontos de extremidade do conector, e nunca compra créditos nem altera configurações de pagamento. Utilize o aplicativo “Fazenda de Executores”, com login, para essas ações.

SolicitaçãoEscopo
GET, HEADdocs:read
Um caminho que gerencia concessões, links de compartilhamento ou publicaçãodocs:share
DELETE, ou um caminho que termine em /purgedocs:delete
Um caminho que termine em /exportdocs:export
Qualquer outra alteraçãodocs:write

A exclusão de uma imagem dentro de um documento é uma edição comum e requer docs:write.

O gerenciamento de webhooks utiliza /v1/webhooks e webhooks:manage. Consulte o guia dedicado guia de webhooks para registro de endpoints, verificação de entrega assinada, proteção contra repetição e rotação de segredos.

  • Utilize GET /v1/version para obter informações sobre a versão do Gateway.
  • Ignore campos de resposta adicionais que seu cliente não reconheça.
  • Leia os cabeçalhos de limite em tempo real em vez de codificar valores de plano de forma estática.
  • Utilize o conjunto de escopos com o mínimo de privilégios.
  • Siga as notas de lançamento do site de documentação ao adotar uma nova rota.