Pular para o conteúdo
Referência de API
Referência de API

Excluir um File

Excluir logicamente um Arquivo e agendar a limpeza do conteúdo armazenado.

Ver Markdown

Excluir logicamente um Arquivo e agendar a limpeza do conteúdo armazenado.

Endpoint

DELETE /v1/files/:file_id
URL base
https://runapi.ai
Versão da API
v1
Autenticação
Authorization: Bearer YOUR_API_KEY
02

Solicitação

Corpo JSON

Envie valores apenas no local de requisição listado.

Parâmetros de caminho1 campo
file_idstring
Obrigatório

ID de arquivo do RunAPI.

03

Resposta de sucesso

HTTP 200

DELETE /v1/files/:file_id

JSON 
{
  "deleted": true,
  "id": "file_abc123",
  "object": "file"
}
04

Resposta de erro (401)

HTTP 401
Esquema de resposta
JSON 
{
  "additionalProperties": true,
  "properties": {
    "error": {
      "additionalProperties": true,
      "properties": {
        "code": {
          "type": [
            "string",
            "null"
          ]
        },
        "message": {
          "type": "string"
        },
        "param": {
          "type": [
            "string",
            "null"
          ]
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "message",
        "type"
      ],
      "type": "object"
    }
  },
  "required": [
    "error"
  ],
  "type": "object"
}

Exemplo de resposta

JSON 
{
  "error": {
    "code": "authentication_error",
    "message": "Missing API key",
    "param": null,
    "type": "authentication_error"
  }
}
05

Resposta de erro (404)

HTTP 404
Esquema de resposta
JSON 
{
  "additionalProperties": true,
  "properties": {
    "error": {
      "additionalProperties": true,
      "properties": {
        "code": {
          "type": [
            "string",
            "null"
          ]
        },
        "message": {
          "type": "string"
        },
        "param": {
          "type": [
            "string",
            "null"
          ]
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "message",
        "type"
      ],
      "type": "object"
    }
  },
  "required": [
    "error"
  ],
  "type": "object"
}

Exemplo de resposta

JSON 
{
  "error": {
    "code": "not_found",
    "message": "File not found",
    "param": null,
    "type": "invalid_request_error"
  }
}
06

Resposta de erro (502)

HTTP 502
Esquema de resposta
JSON 
{
  "additionalProperties": true,
  "properties": {
    "error": {
      "additionalProperties": true,
      "properties": {
        "code": {
          "type": [
            "string",
            "null"
          ]
        },
        "message": {
          "type": "string"
        },
        "param": {
          "type": [
            "string",
            "null"
          ]
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "message",
        "type"
      ],
      "type": "object"
    }
  },
  "required": [
    "error"
  ],
  "type": "object"
}

Exemplo de resposta

JSON 
{
  "error": {
    "code": "storage_write_failed",
    "message": "File storage failed",
    "param": null,
    "type": "server_error"
  }
}
07

Exemplo de cURL

CURL 
curl -X DELETE https://runapi.ai/v1/files/file_abc123 \
  -H 'Authorization: Bearer YOUR_API_KEY'