Endpoints
Every REST endpoint with its scope and credit cost
Base URL: https://studio.verber.me/api/v1. Paths below are relative to it.
Request and response schemas are in the
OpenAPI spec.
| Method | Path | Summary | Scope | Credits |
|---|---|---|---|---|
GET | /me | Current principal and scopes | read | — |
GET | /workspaces | List workspaces you belong to | read | — |
GET | /workspaces/{workspaceId} | Get a workspace | read | — |
GET | /workspaces/{workspaceId}/brand-kit | Get the brand kit | read | — |
PATCH | /workspaces/{workspaceId}/brand-kit | Update the brand kit (merge) | write | — |
POST | /workspaces/{workspaceId}/brand-kit/from-url | Set up the brand kit by extracting a website | write | — |
GET | /workspaces/{workspaceId}/products | List products | read | — |
POST | /workspaces/{workspaceId}/products | Create a product | write | — |
POST | /workspaces/{workspaceId}/products/from-url | Create a product by extracting a product page | write | — |
GET | /workspaces/{workspaceId}/products/{productId} | Get a product | read | — |
PATCH | /workspaces/{workspaceId}/products/{productId} | Update a product | write | — |
GET | /workspaces/{workspaceId}/campaigns | List campaigns | read | — |
POST | /workspaces/{workspaceId}/campaigns | Create a campaign | write | — |
GET | /workspaces/{workspaceId}/campaigns/{campaignId} | Get a campaign | read | — |
PATCH | /workspaces/{workspaceId}/campaigns/{campaignId} | Update a campaign | write | — |
GET | /workspaces/{workspaceId}/media | List media (newest first) | read | — |
GET | /workspaces/{workspaceId}/media/{mediaId} | Get a media item | read | — |
POST | /workspaces/{workspaceId}/media/upload-url | Get a 15-minute signed PUT URL | write | — |
POST | /workspaces/{workspaceId}/media/complete | Register an uploaded file as media | write | — |
GET | /presets | List UGC / product / video-storyboard presets | read | — |
POST | /workspaces/{workspaceId}/generations/image | Generate an image (saved to media) | generate | 1 per image |
POST | /workspaces/{workspaceId}/generations/copy | Generate social copy | generate | 0 |
POST | /workspaces/{workspaceId}/generations/preset | Run a content preset | generate | 1 per preset output |
GET | /workspaces/{workspaceId}/posts | List posts | read | — |
POST | /workspaces/{workspaceId}/posts | Create a draft or scheduled post | write | — |
GET | /workspaces/{workspaceId}/posts/{postId} | Get a post | read | — |
DELETE | /workspaces/{workspaceId}/posts/{postId} | Delete an unpublished post | write | — |
POST | /workspaces/{workspaceId}/posts/{postId}/schedule | Schedule (or unschedule with null) | publish | — |
POST | /workspaces/{workspaceId}/posts/{postId}/queue | Add to a posting queue | publish | — |
GET | /workspaces/{workspaceId}/posts/{postId}/publish | Credit preview for publish-now | read | — |
POST | /workspaces/{workspaceId}/posts/{postId}/publish | Publish now | publish | Per platform via API; 0 via Agent session |
GET | /workspaces/{workspaceId}/social-accounts | List connected social accounts | read | — |
GET | /workspaces/{workspaceId}/queues | List posting queues | read | — |
GET | /credits | Credit balance | read | — |
GET | /credits/transactions | Recent credit transactions | read | — |
GET | /credits/purchase-link | Link to buy credits | read | — |