“questions”: Array<{
“question”: string;
“response”: string;
}>;
Documentação API
Transforme seus documentos com facilidade e eficiência com nossa API
Gerar documento com Legal Design
Sumário
Arquivo Insomnia e explicação das rotas
Para facilitar a integração e o teste da nossa API, disponibilizamos um arquivo Insomnia que contém todas as rotas necessárias. Esse arquivo permite que você experimente nossas funcionalidades de forma rápida e eficiente.
Download do arquivo Insomnia
Você pode baixar o arquivo Postman clicando no link abaixo:
Importando o arquivo Insomnia
Para importar o arquivo Insomnia em sua aplicação Insomnia, siga os passos abaixo:
- Abra o Insomnia.
- Clique em Import.
- Selecione o arquivo que você baixou e clique em Open.
- O arquivo será importado e você verá uma coleção contendo todas as rotas disponíveis.
Explicação das rotas
Nossa API possui uma rota principal que você precisará utilizar para transformar seus documentos jurídicos. Abaixo, detalhamos essa rota e como utilizá-la.
Versão da API
V1: https://apiia.uxdoc.com.br
Gerar documento com Legal Design
Enviar documento com Webhook
Nesta seção, vamos explicar como enviar um documento com Webhook. Esta rota permite que você envie um documento em formato Word, que será processado e transformado conforme as configurações fornecidas.
Rota: Enviar Documento
Método: PATCH
URL: {{ _.baseURL }}/oneclick/analyze-clause-and-design-queue
Autenticação: Bearer token (veja a seção de autenticação para mais detalhes)
Parâmetros da requisição: Headers
Authorization: Bearer {seu-token}
Content-Type: multipart/form-data
Corpo (multipart/form-data)
docx: Arquivo em formato Word (.docx) a ser processado (máximo de 10MB)
Campos de Query
| Campo | Tipo | Descrição |
|---|---|---|
|
ux_writing* |
boolean |
Escolha se deseja aplicar o UX Writing ao documento. Envie true para aplicar o UX Writing ou false para manter o texto original. |
|
main_color* |
string |
Cor principal do documento, em formato hexadecimal (por exemplo, #FF5733). Esta cor será usada como a cor principal no design do documento. |
|
logo_url |
string |
URL da logo do usuário. A logo deve estar em formato quadrado, não muito grande, com tamanho máximo de 1MB, e nos formatos PNG ou JPG. |
|
highlights* |
boolean |
Escolha se deseja aplicar destaques de textos e listas no documento. |
|
is_summary |
boolean |
Escolha de desejar aplicar sumário automático. |
* campos obrigatórios
Resposta da API
A resposta inicial indicará que o documento foi enviado com sucesso para a fila de processamento. O tempo médio de resposta é de aproximadamente 2 segundos. Após o processamento, o resultado será enviado para o Webhook configurado.
{
"reponse": {
"queue_id": string,
"created_at": Date,
}
}
Enviar documento sem Webhook
Nesta seção, vamos explicar como enviar um documento sem Webhook. Esta rota permite que você envie um documento em formato Word, que será processado e transformado conforme as configurações fornecidas.
Rota: Enviar Documento
Método: PATCH
URL: {{ _.baseURL }}/oneclick/analyze-clause-and-design
Autenticação: Bearer token (veja a seção de autenticação para mais detalhes)
Parâmetros da requisição: Headers
Authorization: Bearer {seu-token}
Content-Type: multipart/form-data
Corpo (multipart/form-data)
docx: Arquivo em formato Word (.docx) a ser processado (máximo de 10MB)
Campos de Query
| Campo | Tipo | Descrição |
|---|---|---|
|
ux_writing* |
boolean |
Escolha se deseja aplicar o UX Writing ao documento. Envie true para aplicar o UX Writing ou false para manter o texto original. |
|
main_color* |
string |
Cor principal do documento, em formato hexadecimal (por exemplo, #FF5733). Esta cor será usada como a cor principal no design do documento. |
|
logo_url |
string |
URL da logo do usuário. A logo deve estar em formato quadrado, não muito grande, com tamanho máximo de 1MB, e nos formatos PNG ou JPG. |
|
highlights* |
boolean |
Escolha se deseja aplicar destaques de textos e listas no documento. |
|
is_summary |
boolean |
Escolha de desejar aplicar sumário automático. |
|
download_type* |
string |
Opções válidas: ‘docx’, ‘pptx’ e ‘pdf’. |
* campos obrigatórios
Requisitos para o arquivo do documento para rotas com e sem Webhook:
Formato: .docx
Tamanho máximo: 10MB
Estrutura: O arquivo deve conter apenas títulos, cláusulas e partes. Evite incluir os seguintes elementos:
- Partes de assinatura
- Capa
- Quadro resumo
- Anexos
Siga o exemplo desse documento abaixo:
Download documento Word padrão UX DOC API.
Gerar contrato automático
Perguntas adicionais
Nesta seção, vamos explicar como utilizar esta rota para gerar perguntas adicionais antes de criar o contrato por completo. Você poderá também criar suas perguntas sem a necessidade de utilizar esta rota.
Rota: Gerar Perguntas
Método: POST
URL: {{ _.baseURL }}/create-contracts/generate-firts-questions
Autenticação: Bearer token (veja a seção de autenticação para mais detalhes)
Parâmetros da requisição: Headers
Authorization: Bearer {seu-token}
Content-Type: application/json
Campos do Body
| Campo | Tipo | Descrição |
|---|---|---|
|
contract_type* |
string |
Informar o tipo do documento. Exemplo: Contrato de prestação de serviços |
|
parts_number* |
string |
Informar a quantidade de partes do documento. |
|
object* |
string |
Informar o objetivo/objeto do que precisar constar no contrato. |
* campos obrigatórios
Resposta da API
{
"questions": [
{
"question": "Qual o período de duração do contrato de prestação de serviço de aluguel de cadeiras para festas infantis? Incluir data de início e término, se aplicável, ou critério para renovação/rescisão."
},
{
"question": "Além do aluguel das cadeiras, o contrato incluirá serviços adicionais, como entrega, montagem, ou desmontagem? Se sim, detalhe as responsabilidades de cada parte em relação a esses serviços."
},
{
"question": "Quais são as condições de uso e conservação das cadeiras durante o período de locação? Especificar as responsabilidades do locatário em caso de danos ou perdas, e como será feita a avaliação e cobrança de eventuais prejuízos."
}
]
}
Gerar contrato
Nesta seção, vamos explicar como utilizar esta rota para gerar o contrato.
Rota: Gerar Contrato
Método: POST
URL: {{ _.baseURL }}/create-contracts/generate-document
Autenticação: Bearer token (veja a seção de autenticação para mais detalhes)
Parâmetros da requisição: Headers
Authorization: Bearer {seu-token}
Content-Type: application/json
Campos do Body
| Campo | Tipo | Descrição |
|---|---|---|
|
contract_type* |
string |
Informar o tipo do documento. Exemplo: Contrato de prestação de serviços |
|
parts_number* |
string |
Informar a quantidade de partes do documento. |
|
object* |
string |
Informar o objetivo/objeto do que precisar constar no contrato. |
|
questions* |
array |
|
|
docx_base64 |
string |
Informar algum documento modelo, para contextualizar a geração do contrato pela nossa IA. Formato do arquivo: docx, em formato base64. |
* campos obrigatórios
Resposta da API
{
"base64_document": "base64 aqui"
}
Deletar arquivo
Nesta seção, vamos explicar como deletar um arquivo recebido pelas rotas anteriores.
Observação: Salve os arquivos recebidos das rotas anteriores na sua aplicação. Para remover os arquivos do nosso servidos gerados nas rotas anteriores utilizar a rota aqui descrita.
Ao deletar o arquivo ele é instantaneamente removido dos nossos servidores, porém, como utilizamos CDN pode haver registro de cache existente, permitindo que o documento seja acessado pela URL mesmo após ser deletado, até que a CDN seja atualizada.
Rota: Deletar Arquivo
Método: POST
URL: {{ _.baseURL }}/download/delete
Autenticação: Bearer token (veja a seção de autenticação para mais detalhes)
Parâmetros da requisição: Headers
Authorization: Bearer {seu-token}
Content-Type: application/json
Campos do Body
| Campo | Tipo | Descrição |
|---|---|---|
|
filename* |
string |
O ‘filename’ é o parâmetro que aparece na URL, após o endereço do CDN. Filename: https://d3li9lpic85oot.cloudfront.net/d7bf8a59-56cb-428a-bc88-35286f92389a.pdf |
* campos obrigatórios
Resposta da API
{
"response": "Successfully deleted"
}
Observações
Certifique-se de que o arquivo Word atende aos requisitos mencionados acima.
Consulte a seção de configuração de Webhook para saber como receber notificações quando o processamento estiver concluído.