Workspace

Workspace information and configuration

List workspaces

GET

https://api.smalk.ai

/api/v1/projects/

Get workspace information via API Key.

Authentication: Requires API Key in the Authorization header.

Returns the workspace associated with your API key, including configuration and settings.

List workspaces › Responses

200

object[]

id

string · uuid · readOnly · required

name

string · maxLength: 255 · required

url

string · uri · maxLength: 500 · required

favicon

null | string · uri · readOnly · required

URL to the website's favicon

is_owner

boolean · readOnly · required

current_user_role

null | string · readOnly · required

current_user_permissions

null | integer · readOnly · required

current_user_permission_flags

string[] · readOnly · required

is_active

boolean · readOnly · required

Whether the project/workspace is active and usable

cancellation_date

null | string · date-time · readOnly · required

Date when this project/workspace will be deactivated due to subscription cancellation

publisher_ads_enabled

boolean · readOnly · required

Whether the publisher ads are enabled for this project

advertiser_ads_enabled

boolean · readOnly · required

Whether the advertiser ads are enabled for this project

geo_enabled

boolean · readOnly · required

Whether legacy GEO features are enabled for this project

analytics_enabled

boolean · readOnly · required

Whether AI traffic analytics are enabled for this project

publisher_geo_activation_enabled

boolean · readOnly · required

Whether the publisher GEO solution (GEO Campaigns + GEO-Ready Articles) is activated for this project. Flipped by staff when a PublisherGEOActivationRequest is approved.

null | object · readOnly · required

description

null | string

category

integer · enum · min: 0 · max: 32767

The brand safety category the project belongs to

0 - Unknown
1 - Apparel
2 - Clothing
3 - Children's Clothing
4 - Formal Wear
5 - Men's Clothing
6 - Plus Size Clothing
7 - Shirts, Tops & Blouses
8 - Sleepwear
9 - Swimwear
10 - Underwear
11 - Women's Clothing
12 - Footwear
13 - Athletic Shoes
14 - Jewelry
15 - Watches & Watch Accessories
16 - Handbags & Purses
17 - Sunglasses
18 - Arts & Entertainment
19 - Arts & Entertainment Awards
20 - Entertainment Industry
21 - Film & TV Industry
22 - Events, Shows & Cultural Attractions
23 - Ticket Sales & Exchanges
24 - Fantasy Sports
25 - Fun & Trivia
26 - Fun Tests & Silly Surveys
27 - Humor & Jokes
28 - Movies & Films
29 - Horror Films
30 - Music & Audio
31 - Music Streams & Downloads
32 - Radio
33 - Offbeat
34 - Edgy & Bizarre
35 - Sports Event Tickets & Ticketing Services
36 - TV & Video
37 - TV Broadcasting
38 - TV Shows & Programs
39 - Visual Art & Design
40 - Autos & Vehicles
41 - Boats & Watercraft
42 - Driving Instruction & Driver Education
43 - Motor Vehicles
44 - Campers & RVs
45 - Cars & Trucks
46 - Hybrid & Alternative Vehicles
47 - Motorcycles
48 - Used Motor Vehicles
49 - Vehicle Dealers
50 - Vehicle Parts & Accessories
51 - Vehicle Repair & Maintenance
52 - Beauty & Personal Care
53 - Anti-Aging
54 - Body Art
55 - Hair Care
56 - Shampoos & Conditioners
57 - Hygiene & Toiletries
58 - Antiperspirants, Deodorants & Body Spray
59 - Feminine Hygiene Products
60 - Make-Up & Cosmetics
61 - Oral Care
62 - Perfumes & Fragrances
63 - Shaving & Grooming
64 - Skin Care
65 - Face Care
66 - Hand & Body Soaps & Cleansers
67 - Spa & Medical Spa
68 - Tanning & Sun Care
69 - Business & Industrial
70 - Building Construction & Maintenance
71 - Building Materials & Supplies
72 - Commercial & General Contracting
73 - HVAC & Climate Control
74 - Hardware Tools & Accessories
75 - Chemical Industry
76 - Commercial & Industrial Printing
77 - Design & Engineering
78 - Energy Industry
79 - Oil & Gas
80 - Renewable & Alternative Energy
81 - Food Service Industry
82 - Industrial Goods & Manufacturing
83 - Industrial Electronics
84 - Plant & Facility
85 - Office
86 - Office Appliances
87 - Office & Facilities Management
88 - Scientific Equipment & Services
89 - Security Equipment & Services
90 - Guns & Firearms
91 - Security Weapons
92 - Travel & Tourism
93 - Accommodations
94 - Hotels, Motels & Resorts
95 - Vacation Rentals
96 - Air Travel
97 - Cruises & Cruise Services
98 - Last Minute Travel
99 - Luggage
100 - Specialty Travel
101 - Tourist Attractions & Destinations
102 - Transportation & Excursions
103 - Bus & Rail Services
104 - Car Rental Services
105 - Taxi Services
106 - Travel Booking Services
107 - Travel Media & Publications
108 - Vacation Packages
109 - Other
110 - Cosmetic Procedures & Body Modification
111 - Dating
112 - Downloadable Utilities
113 - Drugs & Supplements
114 - Get Rich Quick
115 - Politics
116 - References to Sex
117 - Religiond
118 - Sensationalism
119 - Sexual & Reproductive Health
120 - Social Casino Games
121 - Weight Loss
122 - Alcohol
123 - Blocked
124 - Gambling & Betting (18+)

Enum values:

industry

integer · enum · min: 0 · max: 32767

The industry the project belongs to

99 - Other
1 - Travel and Tourism
2 - Food and Beverage
3 - Bank and Assurance
4 - Public Administration
5 - Consulting
6 - Real Estate
7 - Gaming
8 - Health and Wellness
9 - Home, Furniture and Appliances
10 - Kids and Parentality
11 - Legal Services
12 - Lifestyle
13 - Marketing Advices
14 - Communication Advices
15 - Media and Entertainment
16 - Mental health and Psychology
17 - Restaurants and Bars
18 - Science
19 - Music
20 - News
21 - Personal Blog
22 - Pets
23 - Photo and Video
24 - Politics
25 - Arts and Crafts
26 - Automotive and Transportation
27 - Beauty and Skincare
28 - Fashion and Luxury
29 - Business-Entrepreneurship
30 - Climate/Environment
31 - Culture
32 - DIY and Home renovation
33 - E-commerce/Store
34 - Shopping/Retail
35 - Education-Training
36 - Finance/Investing
37 - Software/Apps
38 - Sports, Fitness/Outdoors
39 - Heavy Industry

Enum values:

organization

null | string · uuid

The organization this project belongs to

workspace_type

string · enum · writeOnly

publisher - publisher
advertiser - advertiser

Enum values:

publisher

advertiser

GET/api/v1/projects/

curl https://api.smalk.ai/api/v1/projects \
  --header 'Authorization: <api-key>'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "url": "https://www.example.com/path/to/resource",
    "description": "description",
    "favicon": "https://www.example.com/path/to/resource",
    "is_owner": true,
    "current_user_role": "current_user_role",
    "current_user_permissions": 0,
    "current_user_permission_flags": [
      "string"
    ],
    "category": 0,
    "industry": 99,
    "is_active": true,
    "cancellation_date": "2024-08-25T15:00:00Z",
    "publisher_ads_enabled": true,
    "advertiser_ads_enabled": true,
    "geo_enabled": true,
    "analytics_enabled": true,
    "publisher_geo_activation_enabled": true,
    "organization": "00000000-0000-0000-0000-000000000000",
    "workspace_type": "publisher",
    "update_banner": {
      "key": "string"
    }
  }
]

json

application/json

Ad Placement Inventory Health

List workspaces

GET

https://api.smalk.ai

/api/v1/projects/

Get workspace information via API Key.

Authentication: Requires API Key in the Authorization header.

Returns the workspace associated with your API key, including configuration and settings.

List workspaces › Responses

200

object[]

id

string · uuid · readOnly · required

name

string · maxLength: 255 · required

url

string · uri · maxLength: 500 · required

favicon

null | string · uri · readOnly · required

URL to the website's favicon

is_owner

boolean · readOnly · required

current_user_role

null | string · readOnly · required

current_user_permissions

null | integer · readOnly · required

current_user_permission_flags

string[] · readOnly · required

is_active

boolean · readOnly · required

Whether the project/workspace is active and usable

cancellation_date

null | string · date-time · readOnly · required

Date when this project/workspace will be deactivated due to subscription cancellation

publisher_ads_enabled

boolean · readOnly · required

Whether the publisher ads are enabled for this project

advertiser_ads_enabled

boolean · readOnly · required

Whether the advertiser ads are enabled for this project

geo_enabled

boolean · readOnly · required

Whether legacy GEO features are enabled for this project

analytics_enabled

boolean · readOnly · required

Whether AI traffic analytics are enabled for this project

publisher_geo_activation_enabled

boolean · readOnly · required

Whether the publisher GEO solution (GEO Campaigns + GEO-Ready Articles) is activated for this project. Flipped by staff when a PublisherGEOActivationRequest is approved.

null | object · readOnly · required

description

null | string

category

integer · enum · min: 0 · max: 32767

The brand safety category the project belongs to

0 - Unknown
1 - Apparel
2 - Clothing
3 - Children's Clothing
4 - Formal Wear
5 - Men's Clothing
6 - Plus Size Clothing
7 - Shirts, Tops & Blouses
8 - Sleepwear
9 - Swimwear
10 - Underwear
11 - Women's Clothing
12 - Footwear
13 - Athletic Shoes
14 - Jewelry
15 - Watches & Watch Accessories
16 - Handbags & Purses
17 - Sunglasses
18 - Arts & Entertainment
19 - Arts & Entertainment Awards
20 - Entertainment Industry
21 - Film & TV Industry
22 - Events, Shows & Cultural Attractions
23 - Ticket Sales & Exchanges
24 - Fantasy Sports
25 - Fun & Trivia
26 - Fun Tests & Silly Surveys
27 - Humor & Jokes
28 - Movies & Films
29 - Horror Films
30 - Music & Audio
31 - Music Streams & Downloads
32 - Radio
33 - Offbeat
34 - Edgy & Bizarre
35 - Sports Event Tickets & Ticketing Services
36 - TV & Video
37 - TV Broadcasting
38 - TV Shows & Programs
39 - Visual Art & Design
40 - Autos & Vehicles
41 - Boats & Watercraft
42 - Driving Instruction & Driver Education
43 - Motor Vehicles
44 - Campers & RVs
45 - Cars & Trucks
46 - Hybrid & Alternative Vehicles
47 - Motorcycles
48 - Used Motor Vehicles
49 - Vehicle Dealers
50 - Vehicle Parts & Accessories
51 - Vehicle Repair & Maintenance
52 - Beauty & Personal Care
53 - Anti-Aging
54 - Body Art
55 - Hair Care
56 - Shampoos & Conditioners
57 - Hygiene & Toiletries
58 - Antiperspirants, Deodorants & Body Spray
59 - Feminine Hygiene Products
60 - Make-Up & Cosmetics
61 - Oral Care
62 - Perfumes & Fragrances
63 - Shaving & Grooming
64 - Skin Care
65 - Face Care
66 - Hand & Body Soaps & Cleansers
67 - Spa & Medical Spa
68 - Tanning & Sun Care
69 - Business & Industrial
70 - Building Construction & Maintenance
71 - Building Materials & Supplies
72 - Commercial & General Contracting
73 - HVAC & Climate Control
74 - Hardware Tools & Accessories
75 - Chemical Industry
76 - Commercial & Industrial Printing
77 - Design & Engineering
78 - Energy Industry
79 - Oil & Gas
80 - Renewable & Alternative Energy
81 - Food Service Industry
82 - Industrial Goods & Manufacturing
83 - Industrial Electronics
84 - Plant & Facility
85 - Office
86 - Office Appliances
87 - Office & Facilities Management
88 - Scientific Equipment & Services
89 - Security Equipment & Services
90 - Guns & Firearms
91 - Security Weapons
92 - Travel & Tourism
93 - Accommodations
94 - Hotels, Motels & Resorts
95 - Vacation Rentals
96 - Air Travel
97 - Cruises & Cruise Services
98 - Last Minute Travel
99 - Luggage
100 - Specialty Travel
101 - Tourist Attractions & Destinations
102 - Transportation & Excursions
103 - Bus & Rail Services
104 - Car Rental Services
105 - Taxi Services
106 - Travel Booking Services
107 - Travel Media & Publications
108 - Vacation Packages
109 - Other
110 - Cosmetic Procedures & Body Modification
111 - Dating
112 - Downloadable Utilities
113 - Drugs & Supplements
114 - Get Rich Quick
115 - Politics
116 - References to Sex
117 - Religiond
118 - Sensationalism
119 - Sexual & Reproductive Health
120 - Social Casino Games
121 - Weight Loss
122 - Alcohol
123 - Blocked
124 - Gambling & Betting (18+)

Enum values:

industry

integer · enum · min: 0 · max: 32767

The industry the project belongs to

99 - Other
1 - Travel and Tourism
2 - Food and Beverage
3 - Bank and Assurance
4 - Public Administration
5 - Consulting
6 - Real Estate
7 - Gaming
8 - Health and Wellness
9 - Home, Furniture and Appliances
10 - Kids and Parentality
11 - Legal Services
12 - Lifestyle
13 - Marketing Advices
14 - Communication Advices
15 - Media and Entertainment
16 - Mental health and Psychology
17 - Restaurants and Bars
18 - Science
19 - Music
20 - News
21 - Personal Blog
22 - Pets
23 - Photo and Video
24 - Politics
25 - Arts and Crafts
26 - Automotive and Transportation
27 - Beauty and Skincare
28 - Fashion and Luxury
29 - Business-Entrepreneurship
30 - Climate/Environment
31 - Culture
32 - DIY and Home renovation
33 - E-commerce/Store
34 - Shopping/Retail
35 - Education-Training
36 - Finance/Investing
37 - Software/Apps
38 - Sports, Fitness/Outdoors
39 - Heavy Industry

Enum values:

organization

null | string · uuid

The organization this project belongs to

workspace_type

string · enum · writeOnly

publisher - publisher
advertiser - advertiser

Enum values:

publisher

advertiser