Referência da API

Todos os endpoints, parâmetros, formatos de pedido/resposta e códigos de erro.

URL Base

https://api.ipfs.ninja

Todos os pedidos exigem uma chave de API através do cabeçalho X-Api-Key. Consulta Autenticação para mais detalhes.

Endpoints

Método	Caminho	Descrição	Página
POST	/upload/new	Carregar um ficheiro para o IPFS	Ficheiros
GET	/upload/list	Listar ficheiros carregados	Ficheiros
GET	/file/:cid	Obter metadados de um ficheiro por CID	Ficheiros
PUT	/files/:cid/name	Mudar o nome de um ficheiro	Ficheiros
PUT	/files/:cid/move	Mover um ficheiro para uma pasta	Pastas
POST	/pin	Fixar um CID existente da rede IPFS (suporta pistas de swarm-connect)	Fixação
GET	/pin/:cid	Verificar o estado da fixação	Fixação
POST	/folders	Criar pasta	Pastas
GET	/folders	Listar pastas	Pastas
PUT	/folders/:folderId	Atualizar pasta	Pastas
DELETE	/folders/:folderId	Eliminar pasta	Pastas
POST	/folders/:folderId/snapshot	Criar um instantâneo de uma pasta como um CID de diretório	Pastas
PUT	/folders/:folderId/cors	Definir a configuração de CORS por bucket	Pastas
GET	/folders/:folderId/cors	Obter a configuração de CORS de um bucket	Pastas
DELETE	/folders/:folderId/cors	Remover a configuração de CORS de um bucket	Pastas
GET	/user/profile	Obter o perfil do utilizador	Perfil
POST	/apikeys	Criar chave de API	Chaves de API
GET	/apikeys	Listar chaves de API	Chaves de API
DELETE	/apikeys/:key	Eliminar chave de API	Chaves de API
GET	/analytics	Estatísticas de utilização	Análises
PUT	/gateway-settings	Atualizar as configurações do gateway	Gateways
POST	/gateway-tokens	Criar token de gateway	Gateways
GET	/gateway-tokens	Listar tokens de gateway	Gateways
DELETE	/gateway-tokens/:prefix	Eliminar token de gateway	Gateways
POST	/upload/signed-url	Gerar token de carregamento assinado	Tokens Assinados
GET	/signed-tokens	Listar tokens assinados	Tokens Assinados
DELETE	/signed-tokens/:tokenId	Revogar token assinado	Tokens Assinados
GET	/image/:cid	Otimizar imagem em tempo real	Otimização de Imagens

CIDv1 por predefinição

Os carregamentos e fixações devolvem o CIDv1 moderno (bafk… para conteúdo pequeno de bloco único, bafy… para ficheiros e diretórios maiores) seguindo o perfil IPIP-0499 unixfs-v1-2025. Os CIDs legados Qm… de carregamentos anteriores continuam totalmente resolúveis em qualquer lugar — Qm… é um valor de entrada válido para qualquer endpoint que aceite um CID.

API Compatível com S3

Utiliza qualquer AWS SDK para carregar e gerir ficheiros no IPFS Ninja. Aponta o teu cliente S3 para https://s3.ipfs.ninja com a tua chave de API como credenciais.

https://s3.ipfs.ninja

Operação S3	Descrição
PutObject	Carregar um ficheiro para o IPFS
GetObject	Transferir um ficheiro
HeadObject	Obter metadados do ficheiro
DeleteObject	Desfixar e eliminar um ficheiro
ListObjectsV2	Listar ficheiros com filtragem por prefixo
CreateMultipartUpload	Iniciar um carregamento multiparte (até 5 GB)
UploadPart	Carregar uma parte
CompleteMultipartUpload	Concluir o carregamento multiparte
ListBuckets	Listar os teus gateways
CreateBucket	Criar um gateway (os nomes de bucket são globalmente únicos — devolve BucketAlreadyExists se já estiver ocupado)
DeleteBucket	Eliminar um gateway
PutBucketCors	Configurar regras de CORS por bucket (necessário para utilização com SDKs no browser)
GetBucketCors	Ler a configuração de CORS atual de um bucket
DeleteBucketCors	Remover todas as regras de CORS de um bucket

Consulta Compatibilidade S3 para a documentação completa, exemplos de código e guias de migração.