Pular para o conteúdo

DELETE /assets/{assetId}

API · v1 · Produção · Revisado em · Markdown

Metadados e exclusão condicionada a referências. Contrato v1 · disponível em produção e homologação · operação deleteAssetsAssetId. Guia funcional · Índice · Schemas · Testar em sandbox.

Permissão: assets:delete. Sessão humana ou chave de servidor limitada ao proprietário e aos aplicativos autorizados. OAuth/MCP ainda não estão disponíveis. Uma chave de exemplo deve incluir somente esta permissão e as leituras necessárias ao seu fluxo, restrita a app_loja; emita-a na área autenticada de desenvolvedores.

Disponível em produção e homologação; sujeito às capacidades do app e à configuração do provedor. OAuth só será aceito após B1b. Campos desconhecidos rejeitados. Consulte os ADRs para regras semânticas além do JSON Schema.

O efeito é autenticado, auditado e pode gerar publicação eventual e eventos do recurso. Links/domínios/templates podem precisar de propagação antes de aparecerem publicamente. Não muda identidade de link implicitamente. Dependências e capabilities podem bloquear a ação. O status confirma a persistência descrita, sem prometer propagação global imediata.

Nome Local Obrigatório Tipo e restrições
assetId path sim OpaqueId; {“type”:“string”,“maxLength”:500,“minLength”:1,“pattern”:“^[^/\u0000-\u001f\u007f]+$”}
Idempotency-Key header sim UUID v4 por intenção. Recibo por 24h. Mudança de payload/precondição retorna 409. Segredo de chave não é reexibido. IdempotencyKey; {“type”:“string”,“maxLength”:36,“pattern”:“^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$”}
If-Match header sim ETag forte obtido em consulta. Ausência 428; revisão antiga 412. IfMatch; {“type”:“string”,“maxLength”:38,“pattern”:“^"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"$”}

Sem corpo. Envie os parâmetros na URL e os headers indicados.

Omitir campos opcionais usa o default documentado ou preserva o valor em PATCH. null só é aceito nos campos cujo schema permite null, com efeito de limpar/desvincular indicado no guia. Arrays enviados substituem a coleção quando o endpoint define atualização completa; não implicam merge. Identificadores/owner/app de um recurso existente não são transferidos por PATCH. Herança de templates/UTMs segue o guia, sem alterar links anteriores por cópia automática.

AGILINK_API_KEY deve ficar no servidor. Os placeholders abaixo são fictícios. Preserve Idempotency-Key e payload ao repetir uma intenção após timeout.

Janela do terminal
curl --request DELETE 'https://api.staging.agilink.io/v1/assets/90000000-0000-4000-8000-000000000001' \
--header 'Authorization: Bearer <credencial>' \
--header 'Idempotency-Key: 10000000-0000-4000-8000-000000000001' \
--header 'If-Match: "20000000-0000-4000-8000-000000000001"'
// Node.js 22+. Defina AGILINK_API_KEY no ambiente do servidor.
const response = await fetch('https://api.staging.agilink.io/v1/assets/90000000-0000-4000-8000-000000000001', {
method: 'DELETE',
headers: {
"Authorization": `Bearer ${process.env.AGILINK_API_KEY}`,
"Idempotency-Key": "10000000-0000-4000-8000-000000000001",
"If-Match": "\"20000000-0000-4000-8000-000000000001\""
},
redirect: 'error', signal: AbortSignal.timeout(30000)
});
if (!response.ok) throw new Error('HTTP '+response.status+' requestId='+response.headers.get('X-Request-Id'));
// 204: corpo vazio.
# Python 3.10+; pip install requests
import os
import requests
headers = {
"Authorization": "Bearer " + os.environ["AGILINK_API_KEY"],
"Idempotency-Key": "10000000-0000-4000-8000-000000000001",
"If-Match": "\"20000000-0000-4000-8000-000000000001\""
}
response = requests.request(
'DELETE', 'https://api.staging.agilink.io/v1/assets/90000000-0000-4000-8000-000000000001',
headers=headers,
timeout=30, allow_redirects=False)
if not 200 <= response.status_code < 300:
raise RuntimeError(f'HTTP {response.status_code}; requestId={response.headers.get("X-Request-Id")}')
# 204: sem corpo.

Bytes removidos do R2 e ativo marcado como deleted. Corpo vazio.

Header Significado Exemplo
X-Request-Id Identificador gerado pelo servidor, inclusive para falhas e replays. conforme resposta
Cache-Control Respostas administrativas não podem ser armazenadas. no-store, no-transform

Corpo vazio (204); não chamar response.json().

Idempotency-Key UUID v4 é obrigatório, por intenção e credencial, por 24 horas. Em resultado incerto, repita exatamente o mesmo método, URL, corpo, revisão e chave. Alterar a intenção exige nova chave. Segredos de emissão não são reexibidos. If-Match forte é obrigatório; ausência 428, revisão antiga 412. Reconsulte e reconcilie antes de tentar nova edição. Não faça retry automático ilimitado.

Status Significado
400 Cabeçalho, query, cursor ou JSON inválido.
401 Credencial inválida, expirada ou revogada.
403 Operação sem permissão ou capacidade desabilitada.
404 Recurso inexistente ou fora dos aplicativos autorizados.
409 Conflito de identidade/idempotência; operação em andamento ou segredo já exibido.
412 Revisão não corresponde à atual.
413 Corpo excede o limite.
422 JSON bem formado com dados de domínio inválidos.
428 If-Match obrigatório ausente.
429 Quota excedida. Respeitar Retry-After.
500 Falha interna. Use requestId para diagnóstico.
503 Dependência indisponível; resultado da mutação pode ser incerto.
{
"error": {
"code": "unauthenticated",
"message": "Credencial inválida, expirada ou revogada.",
"requestId": "req_00000000000040008000000000000001",
"documentationUrl": "https://docs.agilink.io/api/errors/#unauthenticated"
}
}
{
"error": {
"code": "insufficient_permission",
"message": "Operação sem permissão ou capacidade desabilitada.",
"requestId": "req_00000000000040008000000000000001",
"documentationUrl": "https://docs.agilink.io/api/errors/#insufficient-permission"
}
}
{
"error": {
"code": "idempotency_conflict",
"message": "Conflito de identidade/idempotência; operação em andamento ou segredo já exibido.",
"requestId": "req_00000000000040008000000000000001",
"documentationUrl": "https://docs.agilink.io/api/errors/#idempotency-conflict"
}
}
{
"error": {
"code": "revision_conflict",
"message": "Revisão não corresponde à atual.",
"requestId": "req_00000000000040008000000000000001",
"documentationUrl": "https://docs.agilink.io/api/errors/#revision-conflict"
}
}
{
"error": {
"code": "rate_limited",
"message": "Quota excedida. Respeitar Retry-After.",
"requestId": "req_00000000000040008000000000000001",
"documentationUrl": "https://docs.agilink.io/api/errors/#rate-limited"
}
}
Schema de request
{
"description": "Sem corpo"
}
Schema de response
{
"description": "Corpo vazio"
}

Convenções e limites · Erros · Receitas completas · Guia funcional.