Get in touch Try it for free

Get Started
- Welcome
API Reference

API Reference Categories

List Categories

GET

https://api.sofer.ai/v1/categories/

GET

/v1/categories/

1 from soferai import SoferAI
2 
3 client = SoferAI(
4     api_key="YOUR_TOKEN_HERE"
5 )
6 
7 client.categories.list_categories()

200Retrieved

1 [
2   {
3     "id": "a3f1c2d4-5b6e-4f7a-9c8d-123456789abc",
4     "name": "Work",
5     "color_hex": "#FF5733",
6     "created_at": "2024-01-15T09:30:00Z",
7     "transcription_count": 12
8   },
9   {
10     "id": "b7d9e8f0-1a2b-4c3d-8e9f-abcdef123456",
11     "name": "Personal",
12     "color_hex": "#33A1FF",
13     "created_at": "2024-02-20T14:45:00Z",
14     "transcription_count": 7
15   }
16 ]

Get all categories for the authenticated user

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

This endpoint returns a list of objects.

idUUID

Unique identifier for the category

namestring

Name of the category

color_hexstring

Hex color code for the category

created_atdatetime

When the category was created

descriptionstring or null

Optional description to help categorize transcripts

auto_tag_enabledboolean or null

Whether auto-tagging is enabled for this category

transcription_countinteger or null

Number of transcriptions in this category

Was this page helpful?

Get Category

Get in touch Try it for free