Delete file types

DELETE

file-type

Delete file types

curl --request DELETE \
  --url https://api.orion.file.ai/prod/v1/file-type \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "blueprintIds": [
    "649e2d2d2d2d2d2d2d2d2d2d",
    "649e2d2d2d2d2d2d2d2d2d2e"
  ]
}
'

import requests

url = "https://api.orion.file.ai/prod/v1/file-type"

payload = { "blueprintIds": ["649e2d2d2d2d2d2d2d2d2d2d", "649e2d2d2d2d2d2d2d2d2d2e"] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({blueprintIds: ['649e2d2d2d2d2d2d2d2d2d2d', '649e2d2d2d2d2d2d2d2d2d2e']})
};

fetch('https://api.orion.file.ai/prod/v1/file-type', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "deletedCount": 1,
  "failedCount": 2,
  "errors": [
    {
      "blueprintId": "649e2d2d2d2d2d2d2d2d2d2e",
      "message": "Schema is not found or already deleted"
    },
    {
      "blueprintId": "bad-id",
      "message": "Invalid schema ID format"
    }
  ]
}

{
  "type": "https://errors.file.ai/bad-request",
  "title": "Bad request",
  "status": 400,
  "detail": "Invalid input",
  "instance": "/v1/{route}",
  "code": "BAD_REQUEST",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [],
  "message": "Invalid input",
  "error": "Bad Request",
  "statusCode": 400
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

Request · Response · Guide: Extract fields

More details

Each id is processed independently. The endpoint returns HTTP 200 whenever the request is authorized and the body is valid, even when some or all ids fail — per-id failures are reported in errors[], and success is false only when nothing was deleted and at least one id failed.Deleting an id that was already deleted yields a per-item “Schema is not found or already deleted” error rather than a request-level failure, so retries are safe.Malformed ids are reported as per-item Invalid schema ID format errors, not as a validation failure for the whole request. Duplicate ids are processed once.An id that fails for an unexpected reason reports the generic message Schema could not be deleted; the underlying cause is recorded server-side.At most 50 ids may be sent per request; a larger batch is rejected with 422 VALIDATION_FAILED before any deletion runs. Deletion is performed inline and one id at a time, so split larger sets across requests.The Idempotency-Key header is optional. When supplied, a repeated request with the same key replays the original response for 24 hours.

Authorizations

x-api-key

string

header

required

API key for authentication

Headers

Idempotency-Key

string

Optional opaque key (max 255 chars, UUIDv4 recommended) making this request idempotent for 24h: a retry with the same key and body replays the original response with Idempotent-Replayed: true.

Body

application/json

blueprintIds

string[]

required

File type ids to delete, at most 50 per request. Repeated ids are collapsed and processed once. A malformed id is reported in errors rather than failing the request.

Required array length: 1 - 50 elements

Example:

[
  "649e2d2d2d2d2d2d2d2d2d2d",
  "649e2d2d2d2d2d2d2d2d2d2e"
]

Response

The delete request was processed; inspect the payload for per-id outcomes

success

boolean

deletedCount

number

failedCount

number

errors

object[]

Show child attributes

Delete file types

curl --request DELETE \
  --url https://api.orion.file.ai/prod/v1/file-type \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "blueprintIds": [
    "649e2d2d2d2d2d2d2d2d2d2d",
    "649e2d2d2d2d2d2d2d2d2d2e"
  ]
}
'

import requests

url = "https://api.orion.file.ai/prod/v1/file-type"

payload = { "blueprintIds": ["649e2d2d2d2d2d2d2d2d2d2d", "649e2d2d2d2d2d2d2d2d2d2e"] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({blueprintIds: ['649e2d2d2d2d2d2d2d2d2d2d', '649e2d2d2d2d2d2d2d2d2d2e']})
};

fetch('https://api.orion.file.ai/prod/v1/file-type', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "deletedCount": 1,
  "failedCount": 2,
  "errors": [
    {
      "blueprintId": "649e2d2d2d2d2d2d2d2d2d2e",
      "message": "Schema is not found or already deleted"
    },
    {
      "blueprintId": "bad-id",
      "message": "Invalid schema ID format"
    }
  ]
}

{
  "type": "https://errors.file.ai/bad-request",
  "title": "Bad request",
  "status": 400,
  "detail": "Invalid input",
  "instance": "/v1/{route}",
  "code": "BAD_REQUEST",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [],
  "message": "Invalid input",
  "error": "Bad Request",
  "statusCode": 400
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

Get started

Endpoints

Authorizations

Headers

Body

Response