Atualizar modelo

PATCH

reports

{id}

Atualizar modelo

curl --request PATCH \
  --url https://mcp.base39.com.br/v3/reports/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Análise de empresa"
}
'

import requests

url = "https://mcp.base39.com.br/v3/reports/{id}"

payload = { "name": "Análise de empresa" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Análise de empresa'})
};

fetch('https://mcp.base39.com.br/v3/reports/{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://mcp.base39.com.br/v3/reports/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Análise de empresa'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://mcp.base39.com.br/v3/reports/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Análise de empresa\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://mcp.base39.com.br/v3/reports/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Análise de empresa\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mcp.base39.com.br/v3/reports/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Análise de empresa\"\n}"

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

{
  "object": "report",
  "id": "rpt_00000000000000000000000000000001",
  "name": "Análise de empresa",
  "instructions": "Consultar os dados Base39 e elaborar um relatório em Markdown com evidências e conclusão.",
  "resource_ids": []
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "Revise os parâmetros da requisição."
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "unauthorized",
    "message": "Autenticação necessária."
  }
}

{
  "error": {
    "type": "permission_error",
    "code": "forbidden",
    "message": "Acesso não permitido."
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "Nenhum registro encontrado."
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "method_not_allowed",
    "message": "Método HTTP não permitido para esta operação."
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "request_too_large",
    "message": "A requisição excedeu o limite permitido."
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "unsupported_media_type",
    "message": "Envie o corpo como application/json."
  }
}

{
  "error": {
    "type": "api_error",
    "code": "query_unavailable",
    "message": "Não foi possível concluir a consulta."
  }
}

Autorizações

Authorization

string

header

obrigatório

Credencial OAuth da Base39 com os escopos profile e user:org:read, ou chave de API pertencente à organização. A organização e o autor são obtidos da autenticação.

Parâmetros de caminho

string

obrigatório

Identificador do modelo de relatório na organização autenticada.

Pattern: ^rpt_[a-f0-9]{32}$

Corpo

application/json

name

string

Nome do modelo de relatório.

Required string length: 1 - 256

instructions

string

Instruções em Markdown, incluindo estrutura, critérios e formatos de saída.

Required string length: 1 - 32000

Pattern: \S

resource_ids

string[]

Recursos associados, como modelos de documento, imagens e exemplos, na ordem de uso.

Maximum array length: 100

Identificador de um recurso permanente da organização autenticada.

Pattern: ^[A-Za-z0-9_-]{1,128}$

Resposta

Modelo atual após a alteração dos campos informados.

object

string

obrigatório

Identifica um modelo de relatório.

Allowed value: "report"

string

obrigatório

Identificador do modelo de relatório na organização autenticada.

Pattern: ^rpt_[a-f0-9]{32}$

name

string

obrigatório

Nome do modelo de relatório.

Required string length: 1 - 256

instructions

string

obrigatório

Instruções em Markdown, incluindo estrutura, critérios e formatos de saída.

Required string length: 1 - 32000

Pattern: \S

resource_ids

string[]

obrigatório

Recursos associados, como modelos de documento, imagens e exemplos, na ordem de uso.

Maximum array length: 100

Identificador de um recurso permanente da organização autenticada.

Pattern: ^[A-Za-z0-9_-]{1,128}$

Atualizar modelo

curl --request PATCH \
  --url https://mcp.base39.com.br/v3/reports/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Análise de empresa"
}
'

import requests

url = "https://mcp.base39.com.br/v3/reports/{id}"

payload = { "name": "Análise de empresa" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Análise de empresa'})
};

fetch('https://mcp.base39.com.br/v3/reports/{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://mcp.base39.com.br/v3/reports/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Análise de empresa'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://mcp.base39.com.br/v3/reports/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Análise de empresa\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://mcp.base39.com.br/v3/reports/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Análise de empresa\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mcp.base39.com.br/v3/reports/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Análise de empresa\"\n}"

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

{
  "object": "report",
  "id": "rpt_00000000000000000000000000000001",
  "name": "Análise de empresa",
  "instructions": "Consultar os dados Base39 e elaborar um relatório em Markdown com evidências e conclusão.",
  "resource_ids": []
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "Revise os parâmetros da requisição."
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "unauthorized",
    "message": "Autenticação necessária."
  }
}

{
  "error": {
    "type": "permission_error",
    "code": "forbidden",
    "message": "Acesso não permitido."
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "Nenhum registro encontrado."
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "method_not_allowed",
    "message": "Método HTTP não permitido para esta operação."
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "request_too_large",
    "message": "A requisição excedeu o limite permitido."
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "unsupported_media_type",
    "message": "Envie o corpo como application/json."
  }
}

{
  "error": {
    "type": "api_error",
    "code": "query_unavailable",
    "message": "Não foi possível concluir a consulta."
  }
}

Consultas

Modelos de relatórios

Saldo e pagamentos

Atualizar modelo

Autorizações

Parâmetros de caminho

Corpo

Resposta