API
Image Recognition API
Categories
Methods allow you to get a complete list or a specific category in Eyrene, view information about them, update all fields, or only select category fields.
GET /сategories
Retrieves a list of categories.
GET /categories
GET
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
limit
optional
String
The number of results to return per page.
offset
optional
String
The initial index from which to return the results.
Response parameters
count integer
The number of categories.
next string (uri) Nullable
Next page.
previous string (uri) Nullable
Previous page.
results array of objects
An array of objects with information about categories:
- id string Category ID.
- name string Category name.
POST /сategories
Сreate a new category.
POST /сategories
POST
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
Category ID.
name
optional
String
Category name.
GET /сategories/{id}
Retrieve detailed information about a category by ID.
GET /сategories/{id}
GET
Request
Path Params
id
required
String
Category ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Response parameters
id string
Category ID.
name string
Category name.
PUT /сategories/{id}
Update all category fields.
PUT /categories/{id}
PUT
Request
Path Params
id
required
String
Category ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
New category ID.
name
optional
String
Category new name.
Response parameters
id string
New category ID.
name string
Category new name.
PATCH /сategories/{id}
Update some of the category fields.
PATCH /categories/{id}
PATCH
Request
Path Params
id
required
String
Category ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
New category ID.
name
optional
String
Category new name.
Response parameters
id string
New category ID.
name string
Category new name.