> ## 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.

# Remove a folder

> Deletes an empty folder. A folder that holds anything needs recursive=true, which permanently deletes everything inside it, mockups included; without it the call is refused and tells you what is in there. This cannot be undone. A call that is cut off part way can be repeated and carries on from where it stopped.

```js Node.js theme={"theme":{"light":"github-light","dark":"vesper"}}
const response = await fetch("https://api.sudomock.com/api/v1/folders/3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  method: "DELETE",
  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/3fa85f64-5717-4562-b3fc-2c963f66afa6");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
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.delete(
    "https://api.sudomock.com/api/v1/folders/3fa85f64-5717-4562-b3fc-2c963f66afa6",
    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/3fa85f64-5717-4562-b3fc-2c963f66afa6")
request = Net::HTTP::Delete.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("DELETE", "https://api.sudomock.com/api/v1/folders/3fa85f64-5717-4562-b3fc-2c963f66afa6", 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/3fa85f64-5717-4562-b3fc-2c963f66afa6"))
    .header("x-api-key", "sm_your_api_key")
    .DELETE()
    .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.Delete, "https://api.sudomock.com/api/v1/folders/3fa85f64-5717-4562-b3fc-2c963f66afa6");
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 DELETE "https://api.sudomock.com/api/v1/folders/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "x-api-key: sm_your_api_key"
```

```json Response theme={"theme":{"light":"github-light","dark":"vesper"}}
{
  "success": true,
  "data": {
    "deleted": "c4f1a7d2-3b85-4e60-9a1f-7d2c5e8b4061",
    "deleted_folders": 4,
    "deleted_psd_mockups": 12,
    "deleted_photo_mockups": 3
  }
}
```


## OpenAPI

````yaml openapi.json DELETE /api/v1/folders/{uuid}
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/{uuid}:
    delete:
      tags:
        - Folders
      summary: Remove a folder
      description: >-
        Deletes an empty folder. A folder that holds anything needs
        recursive=true, which permanently deletes everything inside it, mockups
        included; without it the call is refused and tells you what is in there.
        This cannot be undone. A call that is cut off part way can be repeated
        and carries on from where it stopped.
      operationId: delete_folder_endpoint_api_v1_folders__uuid__delete
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
            description: Folder UUID
          description: Folder UUID
        - name: recursive
          in: query
          required: false
          schema:
            type: boolean
            description: >-
              Delete everything inside the folder as well. Required for a folder
              that is not empty.
            default: false
          description: >-
            Delete everything inside the folder as well. Required for a folder
            that is not empty.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderDeleteResponse'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: Node.js
          source: >-
            const response = await
            fetch("https://api.sudomock.com/api/v1/folders/3fa85f64-5717-4562-b3fc-2c963f66afa6",
            {
              method: "DELETE",
              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/3fa85f64-5717-4562-b3fc-2c963f66afa6");

            curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");

            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.delete(
                "https://api.sudomock.com/api/v1/folders/3fa85f64-5717-4562-b3fc-2c963f66afa6",
                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/3fa85f64-5717-4562-b3fc-2c963f66afa6")

            request = Net::HTTP::Delete.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(\"DELETE\", \"https://api.sudomock.com/api/v1/folders/3fa85f64-5717-4562-b3fc-2c963f66afa6\", 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/3fa85f64-5717-4562-b3fc-2c963f66afa6"))
                .header("x-api-key", "sm_your_api_key")
                .DELETE()
                .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.Delete,
            "https://api.sudomock.com/api/v1/folders/3fa85f64-5717-4562-b3fc-2c963f66afa6");

            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 DELETE
            "https://api.sudomock.com/api/v1/folders/3fa85f64-5717-4562-b3fc-2c963f66afa6"
            \
              -H "x-api-key: sm_your_api_key"
components:
  schemas:
    FolderDeleteResponse:
      properties:
        success:
          type: boolean
          description: Always true on a successful response.
          default: true
          examples:
            - true
        data:
          $ref: '#/components/schemas/FolderDeleteData'
          description: What was deleted.
      type: object
      required:
        - data
      title: FolderDeleteResponse
      description: Delete response for DELETE /api/v1/folders/{uuid}.
    FolderDeleteData:
      properties:
        deleted:
          type: string
          description: The folder that was deleted.
          examples:
            - c4f1a7d2-3b85-4e60-9a1f-7d2c5e8b4061
        deleted_folders:
          type: integer
          description: Folders deleted, this one included.
          default: 0
          examples:
            - 4
        deleted_psd_mockups:
          type: integer
          description: PSD mockups deleted.
          default: 0
          examples:
            - 12
        deleted_photo_mockups:
          type: integer
          description: Photo mockups deleted.
          default: 0
          examples:
            - 3
      type: object
      required:
        - deleted
      title: FolderDeleteData
      description: What one delete removed.
  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.