Skip to main content
API docs by Redocly

@qc-apps/api (2.3.0)

Download OpenAPI specification:Download

License: MIT

Overview

The Q-Consultation API consists of various web resources and establishes an API that enhances the features of QuickBlox. You have the ability to interact with these resources directly by employing specific actions using standard HTTP protocols.

Should you require additional functionalities provided by QuickBlox, make use of QuickBlox Server API.

The Q-Consultation API is constructed following RESTful principles, which are a defined set of guidelines for implementing and utilizing the HTTP protocol. Consequently, when you send HTTP requests, the received data is in the format of JSON payloads. Through the Server API, you can seamlessly integrate Q-Consultation's capabilities into your own application.

Base URL

Base URL is a value identifying particular API resource. This URL remains constant for all requests and constitutes the first half of the complete request URL.

The second half of the resource URL is the endpoint representing a variable that must be set with appropriate values to access a specific resource. For example, /auth/login.

Headers

A header is an integral part of each Server API request and response indicating information about request and response body and authorization. QuickBlox Server API provides two headers types:

Standard header

A Content-Type API header that tells the server the media type of the request and is used for PUT and POST requests only. Thus, QuickBlox Server API supports application/json and multipart/form-data content type.

Authorization header

The Authorization header enables the server to determine whether the sender has the permission to access the requested resource or perform the operation. This header specifies the authorization method. Each of the methods indicates which token should be passed in an Authorization HTTP header. Authorization header must be in the format Bearer <token>.

There are 3 authorization methods available:

  • apiKey - BEARER_TOKEN set in app config. Used for API integration.
  • providerSession - provider session token.
  • clientSession - client session token.

Limits

Since the Q-Consultation API is built upon QuickBlox, it shares the same limits.

The purpose of the rate limit is to ensure a high quality of QuickBlox service across all QuickBlox accounts, by limiting the number of API requests that an account can produce per second.

If you go over these limits when using REST based APIs, QuickBlox will start returning a HTTP 429 Too Many Requests error.

Read more info about limits on Plans page.

Basic Startup Growth HIPAA Enterprise
10 Mb 25 Mb 50 Mb 50 Mb Contact our sales team

Errors

Possible API errors are as follows:

Code Text Description
400 Bad Request Missing or invalid parameter. Possible causes:
- malformed request parameters.
401 Unauthorized Authorization is missing or incorrect. Possible causes:
- a user tries to authorize with a wrong login or password.
- a user uses invalid session token.
403 Forbidden Access has been refused. Possible causes:
- a user tries to retrieve chat messages for a chat dialog while they are not in the occupants list.
404 Not Found The requested resource could not be found. Possible causes:
- a user tries to retrieve chat messages for the invalid chat dialog ID.
- a user tries to retrieve a custom object record with invalid ID.
422 Unprocessable Entity The request was well-formed but was unable to be followed due to validation errors. Possible causes:
- create a user with the existent login or email.
- provide values in the wrong format to create some object.
429 Too Many Requests Rate limit for your current plan is exceeded.
500 Internal Server Error Server encountered an error, try again later.
503 Service Unavailable Server is at capacity, try again later.

Appointments

Create new appointment

Authorizations:
apiKeyproviderSessionclientSession
Request Body schema: application/json
provider_id
required
integer (User ID)

ID of the user. Generated automatically by the server after user creation

client_id
required
integer (User ID)

ID of the user. Generated automatically by the server after user creation

description
required
string

Description of the appointment

Responses

Request samples

Content type
application/json
{
  • "provider_id": 0,
  • "client_id": 0,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "user_id": 0,
  • "created_at": 0,
  • "updated_at": 0,
  • "_parent_id": null,
  • "priority": 2,
  • "client_id": 0,
  • "provider_id": 0,
  • "dialog_id": "string",
  • "description": "string",
  • "notes": { },
  • "conclusion": { },
  • "date_end": { },
  • "language": { }
}

Get a list of all appointments

Retrieve a list of all users appointments using an apiKey

Authorizations:
apiKey
query Parameters
limit
integer >= 1
Default: 1000

Limit search results to N records. Useful for pagination

skip
integer >= 0
Default: 0

Skip N records in search results. Useful for pagination.

_id (string) or created_at (string) or updated_at (string) or priority (string) or client_id (string) or provider_id (string) or dialog_id (string) or description (string) or notes (string) or conclusion (string) or date_end (string) or language (string)

Returns appointments with sorting in ascending or descending order

_id (string) or created_at (string) or updated_at (string) or priority (string) or client_id (string) or provider_id (string) or dialog_id (string) or description (string) or notes (string) or conclusion (string) or date_end (string) or language (string)

Returns appointments with sorting in ascending or descending order

priority
integer [ 0 .. 2 ]

The priority of the appointment in the queue

provider_id
integer (User ID)

ID of the user. Generated automatically by the server after user creation

client_id
integer (User ID)

ID of the user. Generated automatically by the server after user creation

date_end[from]
string <date-time>

Date in the ISO 8601 format according to universal time. Format: YYYY-MM-DDTHH:mm:ss.sssZ.

date_end[to]
string <date-time>

Date in the ISO 8601 format according to universal time. Format: YYYY-MM-DDTHH:mm:ss.sssZ.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "limit": 1000,
  • "skip": 0
}

Get a list of my appointments

Retrieve all user appointments list

Authorizations:
providerSessionclientSession
query Parameters
limit
integer >= 1
Default: 1000

Limit search results to N records. Useful for pagination

skip
integer >= 0
Default: 0

Skip N records in search results. Useful for pagination.

_id (string) or created_at (string) or updated_at (string) or priority (string) or client_id (string) or provider_id (string) or dialog_id (string) or description (string) or notes (string) or conclusion (string) or date_end (string) or language (string)

Returns appointments with sorting in ascending or descending order

_id (string) or created_at (string) or updated_at (string) or priority (string) or client_id (string) or provider_id (string) or dialog_id (string) or description (string) or notes (string) or conclusion (string) or date_end (string) or language (string)

Returns appointments with sorting in ascending or descending order

priority
integer [ 0 .. 2 ]

The priority of the appointment in the queue

provider_id
integer (User ID)

Only for clientSession Authorization

client_id
integer (User ID)

Only for providerSession Authorization

date_end[from]
string <date-time>

Date in the ISO 8601 format according to universal time. Format: YYYY-MM-DDTHH:mm:ss.sssZ.

date_end[to]
string <date-time>

Date in the ISO 8601 format according to universal time. Format: YYYY-MM-DDTHH:mm:ss.sssZ.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "limit": 1000,
  • "skip": 0
}

Get appointment by id

Authorizations:
apiKeyproviderSessionclientSession
path Parameters
id
required
string^[a-z0-9]{24}$

ID of the custom object. Generated automatically by the server after creation

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "user_id": 0,
  • "created_at": 0,
  • "updated_at": 0,
  • "_parent_id": null,
  • "priority": 2,
  • "client_id": 0,
  • "provider_id": 0,
  • "dialog_id": "string",
  • "description": "string",
  • "notes": { },
  • "conclusion": { },
  • "date_end": { },
  • "language": { }
}

Update appointment by id

Authorizations:
apiKeyproviderSessionclientSession
path Parameters
id
required
string^[a-z0-9]{24}$

ID of the custom object. Generated automatically by the server after creation

Request Body schema: application/json
priority
integer [ 0 .. 2 ]

The priority of the appointment in the queue

provider_id
integer (User ID)

ID of the user. Generated automatically by the server after user creation

description
string

Description of the appointment

null or string

Notes for appointment

null or string

Conclusions for appointments

null or string

End date of the appointment

null or string

Language of the appointment

Responses

Request samples

Content type
application/json
{
  • "priority": 2,
  • "provider_id": 0,
  • "description": "string",
  • "notes": { },
  • "conclusion": { },
  • "date_end": { },
  • "language": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "user_id": 0,
  • "created_at": 0,
  • "updated_at": 0,
  • "_parent_id": null,
  • "priority": 2,
  • "client_id": 0,
  • "provider_id": 0,
  • "dialog_id": "string",
  • "description": "string",
  • "notes": { },
  • "conclusion": { },
  • "date_end": { },
  • "language": { }
}

Create a record for the appointment

Authorizations:
apiKeyproviderSession
path Parameters
id
required
string^[a-z0-9]{24}$

ID of the custom object. Generated automatically by the server after creation

Request Body schema: multipart/form-data
required
object (File)

This value represents a file submitted using a form with encoding set to multipart/form-data.

object (File)

This value represents a file submitted using a form with encoding set to multipart/form-data.

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "user_id": 0,
  • "created_at": 0,
  • "updated_at": 0,
  • "_parent_id": "string",
  • "uid": "string",
  • "name": "string",
  • "transcription": [
    ],
  • "summary": "string",
  • "actions": "string",
  • "appointment_id": "string"
}

Get a list of records for the appointment

Authorizations:
apiKeyproviderSession
path Parameters
id
required
string^[a-z0-9]{24}$

ID of the custom object. Generated automatically by the server after creation

query Parameters
limit
integer >= 1
Default: 1000

Limit search results to N records. Useful for pagination

skip
integer >= 0
Default: 0

Skip N records in search results. Useful for pagination.

_id (string) or created_at (string) or updated_at (string) or File uid (string) or File name (string) or transcription (string) or summary (string) or actions (string) or appointment_id (string)

Returns records with sorting in ascending or descending order

_id (string) or created_at (string) or updated_at (string) or File uid (string) or File name (string) or transcription (string) or summary (string) or actions (string) or appointment_id (string)

Returns records with sorting in ascending or descending order

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "limit": 1000,
  • "skip": 0
}

Get a record for the appointment

Authorizations:
apiKeyproviderSession
path Parameters
id
required
string^[a-z0-9]{24}$

ID of the custom object. Generated automatically by the server after creation

recordId
required
string^[a-z0-9]{24}$

ID of the custom object. Generated automatically by the server after creation

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "user_id": 0,
  • "created_at": 0,
  • "updated_at": 0,
  • "_parent_id": "string",
  • "uid": "string",
  • "name": "string",
  • "transcription": [
    ],
  • "summary": "string",
  • "actions": "string",
  • "appointment_id": "string"
}

AI

Get audio info

Get transcription, summary and actions for the audio

Authorizations:
apiKeyproviderSession
Request Body schema: multipart/form-data
required
object (File)

This value represents a file submitted using a form with encoding set to multipart/form-data.

buffer
required
any

Record buffer

filename
required
string

Record filename

encoding
required
string

Record encoding

mimetype
required
string

Record mimetype

Responses

Response samples

Content type
application/json
{
  • "transcription": [
    ],
  • "summary": "string",
  • "actions": "string"
}

Get Quick answer for dialog

Authorizations:
providerSession
path Parameters
dialogId
required
string (Dialog ID) ^[a-z0-9]{24}$
clientMessageId
required
string (Message ID) ^[a-z0-9]{24}$

Responses

Response samples

Content type
application/json
{
  • "answer": "string"
}

Rephrase text for dialog

Authorizations:
providerSessionclientSession
path Parameters
dialogId
required
string (Dialog ID) ^[a-z0-9]{24}$
Request Body schema: application/json
text
required
string non-empty
required
Professional Tone (string) or Friendly Tone (string) or Encouraging Tone (string) or Empathetic Tone (string) or Neutral Tone (string) or Assertive Tone (string) or Instructive Tone (string) or Persuasive Tone (string) or Sarcastic/Ironic Tone (string) or Poetic Tone (string)

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "tone": "Professional Tone"
}

Response samples

Content type
application/json
{
  • "rephrasedText": "string"
}

Translate message for user

Authorizations:
providerSessionclientSession
path Parameters
dialogId
required
string (Dialog ID) ^[a-z0-9]{24}$
messageId
required
string (Message ID) ^[a-z0-9]{24}$
Request Body schema: application/json
required
Arabic (string) or Bangla (string) or Czech (string) or Danish (string) or German (string) or Greek (string) or English (string) or Spanish (string) or Finnish (string) or French (string) or Hebrew (string) or Hindi (string) or Hungarian (string) or Indonesian (string) or Italian (string) or Japanese (string) or Korean (string) or Dutch (string) or Norwegian (string) or Polish (string) or Portuguese (string) or Romanian (string) or Russian (string) or Slovak (string) or Swedish (string) or Tamil (string) or Thai (string) or Turkish (string) or Chinese (string) or Ukrainian (string)
Any of
string (Arabic)
Value: "Arabic"

Responses

Request samples

Content type
application/json
{
  • "language": "Arabic"
}

Response samples

Content type
application/json
{
  • "translate": "string"
}

Get suggested providers by name or issue

Authorizations:
apiKeyproviderSessionclientSession
Request Body schema: application/json
topic
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "topic": "string"
}

Response samples

Content type
application/json
{
  • "providers": [
    ]
}

Auth

User login

Request Body schema: application/json
required
client (string) or provider (string)

User's role as a provider or client

email
required
string <email>

User's email

password
required
string

User's password

Responses

Request samples

Content type
application/json
{
  • "role": "client",
  • "email": "user@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "session": {
    },
  • "data": {
    }
}

User logout

Authorizations:
providerSessionclientSession

Responses

Response samples

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

Chat

Get Quick answer for dialog

Authorizations:
providerSession
path Parameters
dialogId
required
string (Dialog ID) ^[a-z0-9]{24}$
clientMessageId
required
string (Message ID) ^[a-z0-9]{24}$

Responses

Response samples

Content type
application/json
{
  • "answer": "string"
}

Rephrase text for dialog

Authorizations:
providerSessionclientSession
path Parameters
dialogId
required
string (Dialog ID) ^[a-z0-9]{24}$
Request Body schema: application/json
text
required
string non-empty
required
Professional Tone (string) or Friendly Tone (string) or Encouraging Tone (string) or Empathetic Tone (string) or Neutral Tone (string) or Assertive Tone (string) or Instructive Tone (string) or Persuasive Tone (string) or Sarcastic/Ironic Tone (string) or Poetic Tone (string)

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "tone": "Professional Tone"
}

Response samples

Content type
application/json
{
  • "rephrasedText": "string"
}

Translate message for user

Authorizations:
providerSessionclientSession
path Parameters
dialogId
required
string (Dialog ID) ^[a-z0-9]{24}$
messageId
required
string (Message ID) ^[a-z0-9]{24}$
Request Body schema: application/json
required
Arabic (string) or Bangla (string) or Czech (string) or Danish (string) or German (string) or Greek (string) or English (string) or Spanish (string) or Finnish (string) or French (string) or Hebrew (string) or Hindi (string) or Hungarian (string) or Indonesian (string) or Italian (string) or Japanese (string) or Korean (string) or Dutch (string) or Norwegian (string) or Polish (string) or Portuguese (string) or Romanian (string) or Russian (string) or Slovak (string) or Swedish (string) or Tamil (string) or Thai (string) or Turkish (string) or Chinese (string) or Ukrainian (string)
Any of
string (Arabic)
Value: "Arabic"

Responses

Request samples

Content type
application/json
{
  • "language": "Arabic"
}

Response samples

Content type
application/json
{
  • "translate": "string"
}

Users

Get suggested providers by name or issue

Authorizations:
apiKeyproviderSessionclientSession
Request Body schema: application/json
topic
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "topic": "string"
}

Response samples

Content type
application/json
{
  • "providers": [
    ]
}

Delete user by id

Delete a user by ID. The user can only be deleted using the apiKey

Authorizations:
apiKey
path Parameters
id
required
integer (User ID)

ID of the user. Generated automatically by the server after user creation

Responses

Response samples

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

Get user by id

Authorizations:
apiKeyproviderSessionclientSession
path Parameters
id
required
integer (User ID)

ID of the user. Generated automatically by the server after user creation

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "full_name": "string",
  • "email": "user@example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_request_at": "2019-08-24T14:15:22Z",
  • "custom_data": "string",
  • "user_tags": "string"
}

Create client

Request Body schema: application/json
full_name
required
string [ 3 .. 60 ] characters

User's full name

email
required
string <email>

User's email

birthdate
required
string (Date) ^\d{4}-\d{2}-\d{2}$

User's birthday. Format: yyyy-MM-dd

required
male (string) or female (string)

User's gender

address
string

User's address

language
string

User's language

password
required
string

User's password

Responses

Request samples

Content type
application/json
{
  • "full_name": "string",
  • "email": "user@example.com",
  • "birthdate": "string",
  • "gender": "male",
  • "address": "string",
  • "language": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "session": {
    },
  • "user": {
    }
}

Update client profile

Update a client profile. A user can be updated only by themselves or an account owner

Authorizations:
clientSession
Request Body schema: application/json
Any of
full_name
required
string [ 3 .. 60 ] characters

User's full name

email
required
string <email>

User's email

birthdate
required
string (Date) ^\d{4}-\d{2}-\d{2}$

User's birthday. Format: yyyy-MM-dd

required
male (string) or female (string)

User's gender

address
string

User's address

language
string

User's language

Responses

Request samples

Content type
application/json
Example
{
  • "full_name": "string",
  • "email": "user@example.com",
  • "birthdate": "string",
  • "gender": "male",
  • "address": "string",
  • "language": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "full_name": "string",
  • "email": "user@example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_request_at": "2019-08-24T14:15:22Z",
  • "custom_data": "string",
  • "user_tags": "string"
}

Update client by id

Update a specific client profile by ID using an apiKey

Authorizations:
apiKey
path Parameters
id
required
integer (User ID)

ID of the user. Generated automatically by the server after user creation

Request Body schema: application/json
full_name
required
string [ 3 .. 60 ] characters

User's full name

email
required
string <email>

User's email

birthdate
required
string (Date) ^\d{4}-\d{2}-\d{2}$

User's birthday. Format: yyyy-MM-dd

required
male (string) or female (string)

User's gender

address
string

User's address

language
string

User's language

password
string

User's password

Responses

Request samples

Content type
application/json
{
  • "full_name": "string",
  • "email": "user@example.com",
  • "birthdate": "string",
  • "gender": "male",
  • "address": "string",
  • "language": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "full_name": "string",
  • "email": "user@example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_request_at": "2019-08-24T14:15:22Z",
  • "custom_data": "string",
  • "user_tags": "string"
}

Create Guest client

Creates a new guest client

Authorizations:
apiKeyproviderSession
Request Body schema: application/json
full_name
required
string [ 3 .. 60 ] characters

User's full name

Responses

Request samples

Content type
application/json
{
  • "full_name": "string"
}

Response samples

Content type
application/json
{
  • "session": {
    },
  • "user": {
    }
}

Get user profile

Authorizations:
providerSessionclientSession

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "full_name": "string",
  • "email": "user@example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_request_at": "2019-08-24T14:15:22Z",
  • "custom_data": "string",
  • "user_tags": "string"
}

Create provider

Request Body schema: application/json
full_name
required
string [ 3 .. 60 ] characters

User's full name

email
required
string <email>

User's email

profession
required
string

User's profession

description
string

Description of the user's profession

language
string

User's language

password
required
string

User's password

Responses

Request samples

Content type
application/json
{
  • "full_name": "string",
  • "email": "user@example.com",
  • "profession": "string",
  • "description": "string",
  • "language": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "session": {
    },
  • "user": {
    }
}

Update provider profile

Update a provider profile. A user can be updated only by themselves or an account owner

Authorizations:
providerSession
Request Body schema: application/json
Any of
full_name
string [ 3 .. 60 ] characters

User's full name

email
string <email>

User's email

profession
string

User's profession

description
string

Description of the user's profession

language
string

User's language

Responses

Request samples

Content type
application/json
Example
{
  • "full_name": "string",
  • "email": "user@example.com",
  • "profession": "string",
  • "description": "string",
  • "language": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "full_name": "string",
  • "email": "user@example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_request_at": "2019-08-24T14:15:22Z",
  • "custom_data": "string",
  • "user_tags": "string"
}

Update provider by id

Update a specific provider profile by ID using an apiKey

Authorizations:
apiKey
path Parameters
id
required
integer (User ID)

ID of the user. Generated automatically by the server after user creation

Request Body schema: application/json
full_name
required
string [ 3 .. 60 ] characters

User's full name

email
required
string <email>

User's email

profession
required
string

User's profession

description
string

Description of the user's profession

language
string

User's language

password
string

User's password

Responses

Request samples

Content type
application/json
{
  • "full_name": "string",
  • "email": "user@example.com",
  • "profession": "string",
  • "description": "string",
  • "language": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "full_name": "string",
  • "email": "user@example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_request_at": "2019-08-24T14:15:22Z",
  • "custom_data": "string",
  • "user_tags": "string"
}

Delete user avatar

Authorizations:
apiKey
path Parameters
id
required
integer (User ID)

ID of the user. Generated automatically by the server after user creation

Responses

Response samples

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

Get user avatar

Authorizations:
apiKeyproviderSessionclientSession
path Parameters
id
required
integer (User ID)

ID of the user. Generated automatically by the server after user creation

Responses

Response samples

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

Upload user avatar

Delete a user by ID. The user can only be deleted using the apiKey

Authorizations:
apiKey
path Parameters
id
required
integer (User ID)

ID of the user. Generated automatically by the server after user creation

Request Body schema: multipart/form-data
required
object (File)

This value represents a file submitted using a form with encoding set to multipart/form-data.

buffer
required
any

Record buffer

filename
required
string

Record filename

encoding
required
string

Record encoding

mimetype
required
string

Record mimetype

Responses

Response samples

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

Delete user avatar

Authorizations:
providerSessionclientSession

Responses

Response samples

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

Get user avatar

Authorizations:
providerSessionclientSession

Responses

Response samples

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

Upload user avatar

Delete a user by ID. The user can only be deleted using the apiKey

Authorizations:
providerSessionclientSession
Request Body schema: multipart/form-data
required
object (File)

This value represents a file submitted using a form with encoding set to multipart/form-data.

buffer
required
any

Record buffer

filename
required
string

Record filename

encoding
required
string

Record encoding

mimetype
required
string

Record mimetype

Responses

Response samples

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