Campos de um modelo de peça jurídica

curl --request GET \
  --url https://api.juridiq.com.br/docs/templates/{id} \
  --header 'x-juridiq-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/docs/templates/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.juridiq.com.br/docs/templates/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-juridiq-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/docs/templates/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/docs/templates/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "fields": [
    {
      "key": "<string>",
      "module": "LAW_SUIT",
      "personIndex": 123,
      "label": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "issues": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

Documents

Campos de um modelo de peça jurídica

Devolve os campos {{MÓDULO.coluna}} do modelo, um por marcador, na ordem em que aparecem. Na criação da peça:

PERSON da pessoa 1 (PERSON.name ou PERSON.name.1) sai do cliente de personId, com os dados de GET /person/;
LAW_SUIT sai do processo de lawSuitId, com os dados de GET /lawSuit/ (ex.: valor da causa em R$);
GENERAL.date e GENERAL.time saem de agora, no horário de Brasília;
o resto (PERSONALIZED, pessoa 2 em diante, GENERAL.cityState) só por values.

Marcador partido entre trechos de formatação diferente e campo antigo do editor não aparecem na lista; o editor os mostra como campo ao abrir a peça.

Permissão: qualquer usuário do escritório da chave.

Erros: 404 quando o modelo não existe neste escritório. 403 quando a chave é do Claude e o plano do escritório não inclui o MCP, ou quando o acesso do escritório está bloqueado.

GET

docs

templates

{id}

Campos de um modelo de peça jurídica

curl --request GET \
  --url https://api.juridiq.com.br/docs/templates/{id} \
  --header 'x-juridiq-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/docs/templates/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.juridiq.com.br/docs/templates/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-juridiq-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/docs/templates/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/docs/templates/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "fields": [
    {
      "key": "<string>",
      "module": "LAW_SUIT",
      "personIndex": 123,
      "label": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "issues": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

Authorizations

x-juridiq-api-key

string

header

required

Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a documentação de integradores).

Path Parameters

string<uuid>

required

ID do modelo (campo id de GET /docs/templates)

Response

Default Response

string<uuid>

required

ID do modelo

name

string

required

Nome do modelo

fields

object[]

required

Campos do modelo, um por marcador, na ordem em que aparecem

Show child attributes

Primeiros Passos

API Reference

Campos de um modelo de peça jurídica

Authorizations

Path Parameters

Response