Referência da API

Todos os endpoints, parâmetros, formatos de requisição/resposta e códigos de erro.

URL Base

https://api.ipfs.ninja

Todas as requisições exigem uma chave de API pelo cabeçalho X-Api-Key. Consulte Autenticação para detalhes.

Endpoints

Método	Caminho	Descrição	Página
POST	/upload/new	Enviar um arquivo para o IPFS	Arquivos
GET	/upload/list	Listar arquivos enviados	Arquivos
GET	/file/:cid	Obter metadados do arquivo por CID	Arquivos
PUT	/files/:cid/name	Renomear um arquivo	Arquivos
PUT	/files/:cid/move	Mover um arquivo para uma pasta	Pastas
POST	/pin	Fixar um CID existente da rede IPFS (suporta dicas de swarm-connect)	Fixação
GET	/pin/:cid	Verificar status da fixação	Fixação
POST	/folders	Criar pasta	Pastas
GET	/folders	Listar pastas	Pastas
PUT	/folders/:folderId	Atualizar pasta	Pastas
DELETE	/folders/:folderId	Excluir pasta	Pastas
POST	/folders/:folderId/snapshot	Gerar snapshot de uma pasta em um CID de diretório	Pastas
PUT	/folders/:folderId/cors	Definir configuração de CORS por bucket	Pastas
GET	/folders/:folderId/cors	Obter configuração de CORS por bucket	Pastas
DELETE	/folders/:folderId/cors	Remover configuração de CORS por bucket	Pastas
GET	/user/profile	Obter perfil do usuário	Perfil
POST	/apikeys	Criar chave de API	Chaves de API
GET	/apikeys	Listar chaves de API	Chaves de API
DELETE	/apikeys/:key	Excluir chave de API	Chaves de API
GET	/analytics	Estatísticas de uso	Análises
PUT	/gateway-settings	Atualizar 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	Excluir token de gateway	Gateways
POST	/upload/signed-url	Gerar token de upload 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 padrão

Uploads e fixações retornam o CIDv1 moderno (bafk… para conteúdo pequeno de bloco único, bafy… para arquivos e diretórios maiores) seguindo o perfil IPIP-0499 unixfs-v1-2025. CIDs legados Qm… de uploads anteriores continuam totalmente resolvíveis em todo lugar — Qm… é uma entrada válida para qualquer endpoint que aceite um CID.

API Compatível com S3

Use qualquer AWS SDK para enviar e gerenciar arquivos no IPFS Ninja. Aponte seu cliente S3 para https://s3.ipfs.ninja usando sua chave de API como credenciais.

https://s3.ipfs.ninja

Operação S3	Descrição
PutObject	Enviar um arquivo para o IPFS
GetObject	Baixar um arquivo
HeadObject	Obter metadados do arquivo
DeleteObject	Remover a fixação e excluir um arquivo
ListObjectsV2	Listar arquivos com filtragem por prefixo
CreateMultipartUpload	Iniciar um upload multipart (até 5 GB)
UploadPart	Enviar uma parte
CompleteMultipartUpload	Finalizar o upload multipart
ListBuckets	Listar seus gateways
CreateBucket	Criar um gateway (nomes de bucket são globalmente únicos — retorna BucketAlreadyExists se já estiver em uso)
DeleteBucket	Excluir um gateway
PutBucketCors	Configurar regras de CORS por bucket (necessário para uso via SDK no navegador)
GetBucketCors	Ler a configuração atual de CORS de um bucket
DeleteBucketCors	Remover todas as regras de CORS de um bucket

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