Exportação em massa de entidades
curl --request POST \
--url http://api.gu1.ai/entities/export/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"deliveryMode": "<string>",
"recipientEmails": [
"<string>"
],
"format": "<string>",
"filters": {},
"emailLocale": "<string>",
"columns": [
"<string>"
],
"fromSenderId": {},
"fromEmail": "<string>"
}
'import requests
url = "http://api.gu1.ai/entities/export/jobs"
payload = {
"deliveryMode": "<string>",
"recipientEmails": ["<string>"],
"format": "<string>",
"filters": {},
"emailLocale": "<string>",
"columns": ["<string>"],
"fromSenderId": {},
"fromEmail": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
deliveryMode: '<string>',
recipientEmails: ['<string>'],
format: '<string>',
filters: {},
emailLocale: '<string>',
columns: ['<string>'],
fromSenderId: {},
fromEmail: '<string>'
})
};
fetch('http://api.gu1.ai/entities/export/jobs', 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 => "http://api.gu1.ai/entities/export/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'deliveryMode' => '<string>',
'recipientEmails' => [
'<string>'
],
'format' => '<string>',
'filters' => [
],
'emailLocale' => '<string>',
'columns' => [
'<string>'
],
'fromSenderId' => [
],
'fromEmail' => '<string>'
]),
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 := "http://api.gu1.ai/entities/export/jobs"
payload := strings.NewReader("{\n \"deliveryMode\": \"<string>\",\n \"recipientEmails\": [\n \"<string>\"\n ],\n \"format\": \"<string>\",\n \"filters\": {},\n \"emailLocale\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"fromSenderId\": {},\n \"fromEmail\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("http://api.gu1.ai/entities/export/jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"deliveryMode\": \"<string>\",\n \"recipientEmails\": [\n \"<string>\"\n ],\n \"format\": \"<string>\",\n \"filters\": {},\n \"emailLocale\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"fromSenderId\": {},\n \"fromEmail\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.gu1.ai/entities/export/jobs")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"deliveryMode\": \"<string>\",\n \"recipientEmails\": [\n \"<string>\"\n ],\n \"format\": \"<string>\",\n \"filters\": {},\n \"emailLocale\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"fromSenderId\": {},\n \"fromEmail\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyExportação em massa de entidades
Enfileira um job assíncrono que exporta entidades filtradas para CSV, XLSX ou JSON para download no histórico e envio opcional por e-mail.
POST
/
entities
/
export
/
jobs
Exportação em massa de entidades
curl --request POST \
--url http://api.gu1.ai/entities/export/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"deliveryMode": "<string>",
"recipientEmails": [
"<string>"
],
"format": "<string>",
"filters": {},
"emailLocale": "<string>",
"columns": [
"<string>"
],
"fromSenderId": {},
"fromEmail": "<string>"
}
'import requests
url = "http://api.gu1.ai/entities/export/jobs"
payload = {
"deliveryMode": "<string>",
"recipientEmails": ["<string>"],
"format": "<string>",
"filters": {},
"emailLocale": "<string>",
"columns": ["<string>"],
"fromSenderId": {},
"fromEmail": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
deliveryMode: '<string>',
recipientEmails: ['<string>'],
format: '<string>',
filters: {},
emailLocale: '<string>',
columns: ['<string>'],
fromSenderId: {},
fromEmail: '<string>'
})
};
fetch('http://api.gu1.ai/entities/export/jobs', 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 => "http://api.gu1.ai/entities/export/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'deliveryMode' => '<string>',
'recipientEmails' => [
'<string>'
],
'format' => '<string>',
'filters' => [
],
'emailLocale' => '<string>',
'columns' => [
'<string>'
],
'fromSenderId' => [
],
'fromEmail' => '<string>'
]),
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 := "http://api.gu1.ai/entities/export/jobs"
payload := strings.NewReader("{\n \"deliveryMode\": \"<string>\",\n \"recipientEmails\": [\n \"<string>\"\n ],\n \"format\": \"<string>\",\n \"filters\": {},\n \"emailLocale\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"fromSenderId\": {},\n \"fromEmail\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("http://api.gu1.ai/entities/export/jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"deliveryMode\": \"<string>\",\n \"recipientEmails\": [\n \"<string>\"\n ],\n \"format\": \"<string>\",\n \"filters\": {},\n \"emailLocale\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"fromSenderId\": {},\n \"fromEmail\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.gu1.ai/entities/export/jobs")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"deliveryMode\": \"<string>\",\n \"recipientEmails\": [\n \"<string>\"\n ],\n \"format\": \"<string>\",\n \"filters\": {},\n \"emailLocale\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"fromSenderId\": {},\n \"fromEmail\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyVisão geral
Exporta entidades com os mesmos filtros deGET /entities e gera um arquivo (csv, xlsx ou json). Com deliveryMode: "download_only", o arquivo fica disponível no histórico sem enviar e-mail nem consumir créditos de e-mail. Com deliveryMode: "email", ele também é enviado aos destinatários informados. A resposta é 202 com jobId.
Endpoint
POST http://api.gu1.ai/entities/export/jobs
Autenticação, permissões e marketplace
Sempre requerAuthorization, X-Organization-ID e entities:export. A integração global_sender_email, o remetente e o saldo são verificados somente com deliveryMode: "email"; a cobrança é por destinatário. download_only não consome créditos de e-mail.
Domínio e remetente
fromEmail: domínio verificado; remetente cadastrado não é obrigatório.fromSenderId: UUID emorganization_email_senders.- Não enviar os dois juntos.
Corpo JSON
string
download_only para manter o arquivo somente no histórico, ou email para adicionar o envio por e-mail. Por compatibilidade, se omitido com destinatários informados, é interpretado como email.string[]
Obrigatório e não vazio com
deliveryMode: "email" (máx. 26 deduplicados). Deve ser [] com download_only.string
required
csv, xlsx ou json.object
Mesma forma dos filtros de
GET /entities. Padrão {}.string
en, es ou pt para o e-mail de conclusão quando deliveryMode for email.string[]
Colunas snake_case opcionais; omitir = todas permitidas.
string (uuid)
Remetente por UUID. Aplica-se somente a
email e é exclusivo com fromEmail.string
Remetente em domínio verificado. Aplica-se somente a
email e é exclusivo com fromSenderId.Exemplo sem e-mail
{
"deliveryMode": "download_only",
"recipientEmails": [],
"format": "xlsx",
"filters": { "type": "person" }
}
Exemplo com e-mail
{
"deliveryMode": "email",
"recipientEmails": ["analista@exemplo.com"],
"format": "csv",
"emailLocale": "pt",
"fromEmail": "exportacoes@seu-dominio.com",
"filters": {}
}
Resposta 202
{
"jobId": "uuid-do-job",
"status": "queued",
"deliveryMode": "download_only",
"message": "…"
}
Acompanhamento
GET /entities/export/jobs— histórico paginado de exportações da organização.GET /entities/export/jobs/{jobId}— status (queued,running,completed,completed_email_failed,failed) e modo de entrega.GET /entities/export/jobs/{jobId}/download— download autenticado enquanto o arquivo estiver disponível.- Se o envio por e-mail falhar após a geração, o job fica como
completed_email_failede continua disponível no histórico.
fileExpiresAt. O campo aceita null:
nesse caso, o arquivo armazenado não expira. linkExpiresAt é independente e indica
somente quando o link assinado enviado por e-mail deixa de funcionar. Novos arquivos
de exportações de entidades e transações não expiram e permanecem disponíveis no
histórico, salvo remoção explícita.
Erros 400
Os erros de modo incluemEXPORT_RECIPIENTS_REQUIRED, EXPORT_RECIPIENTS_NOT_ALLOWED e EXPORT_STORAGE_REQUIRED. Com deliveryMode: "email", também se aplicam os erros de pre-flight de report-export-email, como domínio não verificado ou saldo insuficiente.
Relacionado
Was this page helpful?