> ## Documentation Index
> Fetch the complete documentation index at: https://sudomock.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> The base URL is https://api.sudomock.com.
> Authenticate every request with the x-api-key header. Keys begin with sm_.
> A render returns the finished image at data.print_files[0].export_path. A request sent with is_async true returns a job_id to poll at GET /api/v1/jobs/{job_id}.
> Prefer the official SDKs over hand-written HTTP calls: npm install sudomock for Node, pip install sudomock for Python.

# Retrieve a list of folders

> List your folders, by name, with pagination. Leave parent_uuid out for every folder you have, send `root` for the ones at the top of the library, or a folder's uuid for the ones directly inside it.

```js Node.js theme={"theme":{"light":"github-light","dark":"vesper"}}
const response = await fetch("https://api.sudomock.com/api/v1/folders", {
  method: "GET",
  headers: { "x-api-key": "sm_your_api_key" },
});

const data = await response.json();
console.log(data);
```

```php PHP theme={"theme":{"light":"github-light","dark":"vesper"}}
<?php

$ch = curl_init("https://api.sudomock.com/api/v1/folders");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: sm_your_api_key",
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
```

```python Python theme={"theme":{"light":"github-light","dark":"vesper"}}
import requests

response = requests.get(
    "https://api.sudomock.com/api/v1/folders",
    headers={"x-api-key": "sm_your_api_key"},
)

response.raise_for_status()
print(response.json())
```

```ruby Ruby theme={"theme":{"light":"github-light","dark":"vesper"}}
require "net/http"
require "uri"

uri = URI("https://api.sudomock.com/api/v1/folders")
request = Net::HTTP::Get.new(uri)
request["x-api-key"] = "sm_your_api_key"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.body
```

```go Go theme={"theme":{"light":"github-light","dark":"vesper"}}
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.sudomock.com/api/v1/folders", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("x-api-key", "sm_your_api_key")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
```

```java Java theme={"theme":{"light":"github-light","dark":"vesper"}}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.sudomock.com/api/v1/folders"))
    .header("x-api-key", "sm_your_api_key")
    .GET()
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());
```

```csharp .NET theme={"theme":{"light":"github-light","dark":"vesper"}}
using System.Net.Http;
using System.Text;

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.sudomock.com/api/v1/folders");
request.Headers.Add("x-api-key", "sm_your_api_key");

var client = new HttpClient();
var response = await client.SendAsync(request);

Console.WriteLine(await response.Content.ReadAsStringAsync());
```

```bash cURL theme={"theme":{"light":"github-light","dark":"vesper"}}
curl -X GET "https://api.sudomock.com/api/v1/folders" \
  -H "x-api-key: sm_your_api_key"
```

```json Response theme={"theme":{"light":"github-light","dark":"vesper"}}
{
  "success": true,
  "data": {
    "folders": [
      {
        "uuid": "c4f1a7d2-3b85-4e60-9a1f-7d2c5e8b4061",
        "name": "Frames",
        "parent_uuid": "9e3b6c14-27af-4d58-b0e1-5c8a2f9d7340",
        "created_at": "2026-01-01T00:00:00Z",
        "updated_at": "2026-01-01T00:00:00Z",
        "folder_count": 3,
        "psd_mockup_count": 12,
        "photo_mockup_count": 4
      }
    ],
    "total": 7,
    "limit": 20,
    "offset": 0
  }
}
```


## OpenAPI

````yaml openapi.json GET /api/v1/folders
openapi: 3.1.0
info:
  title: SudoMock API
  description: >-
    Product mockup API. Render PSD templates, turn product photos into reusable
    mockups, create still images and videos, personalize text with fonts, and
    manage asynchronous jobs and signed webhooks.


    Every endpoint answers failures with the same envelope, so the status codes,
    the error_code values and the retry rule are documented once at
    https://sudomock.com/docs/errors rather than repeated per operation.
  version: 1.0.0
servers:
  - url: https://api.sudomock.com
    description: Production
security: []
tags:
  - name: PSD mockups
    description: Turn a Photoshop file into a reusable mockup, then render it.
  - name: Photo mockups
    description: Turn a product photo into a reusable mockup, then render artwork onto it.
  - name: Video mockups
    description: Render a mockup as a short video.
  - name: Fonts
    description: Upload and manage the fonts available to text layers.
  - name: Background removal
    description: Isolate a subject from its background as a standalone step.
  - name: Patterns
    description: Check a repeating pattern tile for seams and fix them.
  - name: Studio
    description: Open an embedded editor session and read what the customer produced in it.
  - name: Webhook endpoints
    description: Register signed endpoints and manage their secrets.
  - name: Webhook deliveries
    description: Inspect, replay and retry what those endpoints received.
  - name: Jobs
    description: Poll queued renders and seam fixes, and read their results.
  - name: Account
    description: Read the current account, its plan and its remaining credits.
  - name: Folders
    description: Group mockups into folders that nest.
paths:
  /api/v1/folders:
    get:
      tags:
        - Folders
      summary: Retrieve a list of folders
      description: >-
        List your folders, by name, with pagination. Leave parent_uuid out for
        every folder you have, send `root` for the ones at the top of the
        library, or a folder's uuid for the ones directly inside it.
      operationId: get_folders_api_v1_folders_get
      parameters:
        - name: parent_uuid
          in: query
          required: false
          schema:
            type: string
            description: >-
              Folder whose contents to list. `root` lists the folders at the top
              of the library. Leave it out to list every folder.
          description: >-
            Folder whose contents to list. `root` lists the folders at the top
            of the library. Leave it out to list every folder.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Number of folders to return (1-100)
            default: 20
          description: Number of folders to return (1-100)
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            description: Number of folders to skip
            default: 0
          description: Number of folders to skip
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderListResponse'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: Node.js
          source: >-
            const response = await
            fetch("https://api.sudomock.com/api/v1/folders", {
              method: "GET",
              headers: { "x-api-key": "sm_your_api_key" },
            });


            const data = await response.json();

            console.log(data);
        - lang: PHP
          source: |-
            <?php

            $ch = curl_init("https://api.sudomock.com/api/v1/folders");
            curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
            curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
            curl_setopt($ch, CURLOPT_HTTPHEADER, [
                "x-api-key: sm_your_api_key",
            ]);

            $response = curl_exec($ch);
            curl_close($ch);

            echo $response;
        - lang: Python
          source: |-
            import requests

            response = requests.get(
                "https://api.sudomock.com/api/v1/folders",
                headers={"x-api-key": "sm_your_api_key"},
            )

            response.raise_for_status()
            print(response.json())
        - lang: Ruby
          source: >-
            require "net/http"

            require "uri"


            uri = URI("https://api.sudomock.com/api/v1/folders")

            request = Net::HTTP::Get.new(uri)

            request["x-api-key"] = "sm_your_api_key"


            response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do
            |http|
              http.request(request)
            end


            puts response.body
        - lang: Go
          source: "package main\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n)\n\nfunc main() {\n\treq, err := http.NewRequest(\"GET\", \"https://api.sudomock.com/api/v1/folders\", nil)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\treq.Header.Set(\"x-api-key\", \"sm_your_api_key\")\n\n\tres, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer res.Body.Close()\n\n\tbody, _ := io.ReadAll(res.Body)\n\tfmt.Println(string(body))\n}"
        - lang: Java
          source: |-
            import java.net.URI;
            import java.net.http.HttpClient;
            import java.net.http.HttpRequest;
            import java.net.http.HttpResponse;

            HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://api.sudomock.com/api/v1/folders"))
                .header("x-api-key", "sm_your_api_key")
                .GET()
                .build();

            HttpResponse<String> response = HttpClient.newHttpClient()
                .send(request, HttpResponse.BodyHandlers.ofString());

            System.out.println(response.body());
        - lang: .NET
          source: >-
            using System.Net.Http;

            using System.Text;


            var request = new HttpRequestMessage(HttpMethod.Get,
            "https://api.sudomock.com/api/v1/folders");

            request.Headers.Add("x-api-key", "sm_your_api_key");


            var client = new HttpClient();

            var response = await client.SendAsync(request);


            Console.WriteLine(await response.Content.ReadAsStringAsync());
        - lang: cURL
          source: |-
            curl -X GET "https://api.sudomock.com/api/v1/folders" \
              -H "x-api-key: sm_your_api_key"
components:
  schemas:
    FolderListResponse:
      properties:
        success:
          type: boolean
          description: Always true on a successful response.
          default: true
          examples:
            - true
        data:
          $ref: '#/components/schemas/FolderListData'
          description: The page of folders, with its total, limit and offset.
      type: object
      required:
        - data
      title: FolderListResponse
      description: List response for GET /api/v1/folders.
    FolderListData:
      properties:
        folders:
          items:
            $ref: '#/components/schemas/Folder'
          type: array
          description: The folders on this page, by name.
        total:
          type: integer
          description: Folders matching the request, across every page.
          examples:
            - 7
        limit:
          type: integer
          description: Results per page.
          examples:
            - 20
        offset:
          type: integer
          description: Pagination offset.
          examples:
            - 0
      type: object
      required:
        - folders
        - total
        - limit
        - offset
      title: FolderListData
      description: A page of folders.
    Folder:
      properties:
        uuid:
          type: string
          description: The folder's unique identifier.
          examples:
            - c4f1a7d2-3b85-4e60-9a1f-7d2c5e8b4061
        name:
          type: string
          description: The folder's name.
          examples:
            - Frames
        parent_uuid:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The folder this one sits in. Null means it sits at the top of the
            library.
          examples:
            - 9e3b6c14-27af-4d58-b0e1-5c8a2f9d7340
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: When the folder was created.
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: When the folder was last renamed or moved.
        folder_count:
          type: integer
          description: Folders directly inside this one.
          default: 0
          examples:
            - 3
        psd_mockup_count:
          type: integer
          description: PSD mockups directly inside this one.
          default: 0
          examples:
            - 12
        photo_mockup_count:
          type: integer
          description: Photo mockups directly inside this one.
          default: 0
          examples:
            - 4
      type: object
      required:
        - uuid
        - name
      title: Folder
      description: One folder, and how much it holds directly.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key with sm_ prefix. Get your key at
        https://sudomock.com/dashboard/api-keys

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.