OCocoya
Studio templates

List Studio templates

Changed on

Returns Ocoya's public Studio template gallery, which can be used as visual references for AI-generated posts. For the brand's own saved designs, use GET /studio-designs.

get/studio-templates

Request

  • Base URL
    https://www.app.ocoya.com/api/_public/v1
  • Auth
    API key in header X-API-Key

Query parameters

brandIdstring required
Example:cmayvq3hk00017apshay5qezu

Ocoya brand ID. Get one from GET /brands.

querystring
Example:Launch

Search query used to filter results by name or matching text.

pageinteger

Zero-based page number for paginated results.

perPageinteger
Example:20

Maximum number of items to return per page.

Response

Success

totalinteger required

Templates matching the query.

totalFilteredinteger required

Templates matching the query and filters.

totalAllinteger required

All templates available to the brand.

Example response

{
  "total": 1,
  "totalFiltered": 1,
  "totalAll": 24,
  "data": [
    {
      "id": "design_123",
      "name": "Product launch",
      "image": "https://cdn.ocoya.com/prod/template/preview.png",
      "thumbnail": "https://cdn.ocoya.com/prod/template/preview.png",
      "pageThumbnails": [
        "https://cdn.ocoya.com/prod/template/preview.png"
      ],
      "pagesCount": 1,
      "width": 1080,
      "height": 1080
    }
  ]
}

Changes

  • ad0d7f3cdd9bRevision changes
    • warning

      for the query request parameter page, the min was set to 0.00

    • warning

      for the query request parameter perPage, the min was set to 1.00

    • info

      api operation id listStudioTemplates was added

    • info

      api tag Studio templates added

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 9b90d34d13fdRevision changes
    • breaking

      added the new required query request parameter brandId

    • warning

      deleted the query request parameter workspaceId