aiconix logo
API docs by Redocly

File Processing Request OpenAPI Specification (1.0.3)

Download OpenAPI specification:Download

aiconix GmbH: dev@aiconix.ai URL: https://www.aiconix.ai/en/contact Terms of Service

OpenAPI Specification.

Processing operations

File processing operations

Return all requests

return all requests paginated.

Authorizations:
BasicAuthOpenId
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

limit
integer [ 1 .. 50 ]
Default: 20

The numbers of items to return in a set.

Responses

Response samples

Content type
application/json
[]

Create a new request

start a new request

Authorizations:
BasicAuthOpenId
Request Body schema: application/json

start a new request

non-empty
file_url
required
string <uri> (url) https:\/\/.*

file URL for processing

webhook_url
string

webhook url to be called when processing has completed. Will be called with 'OPTIONS' API CALL to verify availability. Webhook response will include result file urls

source_language
string (language)

language identified by locale

object (request.config.identify_languages)
object (request.config.transcribe)
object (request.config.translate)
object (request.config.export_subtitles) non-empty

Responses

Callbacks

Request samples

Content type
application/json
{
  • "file_url": "https://admin.aiconix.cloud/api/batch/v1/files/7a840e6e-4d21-4348-9dbb-5c2c0249bd7c",
  • "webhook_url": "https://customer.callback.server.de/response/123",
  • "source_language": "en",
  • "identify_languages": {
    },
  • "transcribe": {
    },
  • "translate": {
    },
  • "export_subtitles": {
    }
}

Response samples

Content type
application/json
{}

Callback payload samples

Callback
POST: Webhook to inform about completed processing and include result urls
Content type
application/json
{}

Return the request identified by id

return the request identified by id

Authorizations:
BasicAuthOpenId
path Parameters
request_id
required
string <uuid> (id_param.uuid)

id for actual customer request entity

Responses

Response samples

Content type
application/json
{}

File Operations

File management operations

Return all files

return all files paginated.

Authorizations:
BasicAuthOpenId
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

limit
integer [ 1 .. 50 ]
Default: 20

The numbers of items to return in a set.

Responses

Response samples

Content type
application/json
[]

Upload a new file

upload a new file

Authorizations:
BasicAuthOpenId
Request Body schema: multipart/form-data
required

upload a new file

file_name
string
file_type
required
string (file_type)
Enum: "audio" "video" "text" "transcript" "timed text json" "att" "srt" "webvtt"

file type - relevant for further processing and validation.

file
required
string <binary> <binary>

file provided as binary upload, allowed file mimetypes are

  • text/txt, text/srt,
  • audio/wav, audio/mp3, audio/flac, audio/aac, audio/ogg,
  • video/mp4, video/m4a, video/mov, video/webm

Responses

Callbacks

Response samples

Content type
application/json
{}

Callback payload samples

Callback
POST: Webhook to inform about completed processing and include result urls
Content type
application/json
{
  • "file_id": "7a840e6e-4d21-4348-9dbb-5c2c0249bd7c",
  • "file_url": "https://admin.aiconix.cloud/api/batch/v1/files/7a840e6e-4d21-4348-9dbb-5c2c0249bd7c",
  • "file_name": "string",
  • "file_type": "audio",
  • "file_format": "wav",
  • "file_validation": true,
  • "file_size": 0,
  • "mime_type": "audio/aac",
  • "customer_id": "5",
  • "request_logs": [
    ],
  • "created_date": "2063-04-05T17:32:28Z"
}

Delete existing file

delete existing file

Authorizations:
BasicAuthOpenId
path Parameters
file_id
required
string <uuid> (id_param.uuid)

file id

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Return the file identified by id

return the file identified by id

Authorizations:
BasicAuthOpenId
path Parameters
file_id
required
string <uuid> (id_param.uuid)

file id

Responses

Response samples

Content type
application/json
[]

Return the file binary identified by id

return the file in binary identified by id

Authorizations:
BasicAuthOpenId
path Parameters
file_id
required
string <uuid> (id_param.uuid)

file id

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Request the download of a new file

request the download of a new file

Authorizations:
BasicAuthOpenId
Request Body schema: application/json
required

request to download a file

file_name
string
file_type
required
string (file_type)
Enum: "audio" "video" "text" "transcript" "timed text json" "att" "srt" "webvtt"

file type - relevant for further processing and validation.

file_url
required
string <uri> https:\/\/.*

file provided by external publicly available url

webhook_url
string

webhook url to be called when processing has completed. Will be called with 'OPTIONS' API CALL to verify availability. Webhook response will include result file urls

Responses

Callbacks

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Callback payload samples

Callback
POST: Webhook to inform about completed processing and include result urls
Content type
application/json
{
  • "file_id": "7a840e6e-4d21-4348-9dbb-5c2c0249bd7c",
  • "file_url": "https://admin.aiconix.cloud/api/batch/v1/files/7a840e6e-4d21-4348-9dbb-5c2c0249bd7c",
  • "file_name": "string",
  • "file_type": "audio",
  • "file_format": "wav",
  • "file_validation": true,
  • "file_size": 0,
  • "mime_type": "audio/aac",
  • "customer_id": "5",
  • "request_logs": [
    ],
  • "created_date": "2063-04-05T17:32:28Z"
}

Request Template

File processing operations templates

Return all requests template

return all requests template paginated.

Authorizations:
BasicAuthOpenId
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

limit
integer [ 1 .. 50 ]
Default: 20

The numbers of items to return in a set.

enabled
boolean

send enabled only record if true else send all.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new request template

start a new request

Authorizations:
BasicAuthOpenId
Request Body schema: application/json

start a new request

non-empty
name
required
string

template name

enabled
boolean
Default: true
source_language
string (language)

language identified by locale

object (request.config.identify_languages)
object (request.config.transcribe)
object (request.config.translate)
object (request.config.export_subtitles) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enabled": true,
  • "source_language": "en",
  • "identify_languages": {
    },
  • "transcribe": {
    },
  • "translate": {
    },
  • "export_subtitles": {
    }
}

Response samples

Content type
application/json
{
  • "request_template_id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "5",
  • "name": "string",
  • "enabled": true,
  • "source_language": "en",
  • "identify_languages": {
    },
  • "transcribe": {
    },
  • "translate": {
    },
  • "export_subtitles": {
    }
}

Delete existing request template

delete existing request template

Authorizations:
BasicAuthOpenId
path Parameters
request_template_id
required
string <uuid> (id_param.uuid)

id for customer request _template entity

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Return the request template identified by id

return the request template identified by id

Authorizations:
BasicAuthOpenId
path Parameters
request_template_id
required
string <uuid> (id_param.uuid)

id for customer request _template entity

Responses

Response samples

Content type
application/json
{
  • "request_template_id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "5",
  • "name": "string",
  • "enabled": true,
  • "source_language": "en",
  • "identify_languages": {
    },
  • "transcribe": {
    },
  • "translate": {
    },
  • "export_subtitles": {
    }
}

Update existing request template

update existing request template by id

Authorizations:
BasicAuthOpenId
path Parameters
request_template_id
required
string <uuid> (id_param.uuid)

id for customer request _template entity

Request Body schema: application/json

update existing request template by id

non-empty
name
required
string

template name

enabled
boolean
Default: true
source_language
string (language)

language identified by locale

object (request.config.identify_languages)
object (request.config.transcribe)
object (request.config.translate)
object (request.config.export_subtitles) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enabled": true,
  • "source_language": "en",
  • "identify_languages": {
    },
  • "transcribe": {
    },
  • "translate": {
    },
  • "export_subtitles": {
    }
}

Response samples

Content type
application/json
{
  • "request_template_id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "5",
  • "name": "string",
  • "enabled": true,
  • "source_language": "en",
  • "identify_languages": {
    },
  • "transcribe": {
    },
  • "translate": {
    },
  • "export_subtitles": {
    }
}