Funnels

Retrieve all funnels

get

Retrieve all funnels in a workspace.

Responses

200

All funnels in a workspace.

application/json

idstringRequired

The funnel's ID.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

namestringRequired

The funnel's name.

Example: My Funnel

automation_idstringRequired

The funnel's automation ID.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

metadataobjectRequired

The funnel's metadata.

Example: {"prompt":"This is a prompt"}

created_atstring · date-timeRequired

Timestamp of when the funnel was created.

Example: 2025-01-01T00:00:00.000Z

updated_atstring · date-timeRequired

Timestamp of when the funnel was last updated.

Example: 2025-01-01T00:00:00.000Z

401

The user is not authenticated.

403

The user does not have permission to perform this operation.

get

/funnels

HTTPcURLJavaScriptPython

GET /api/v1/funnels HTTP/1.1
Accept: */*

[
  {
    "id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
    "name": "My Funnel",
    "automation_id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
    "metadata": {
      "prompt": "This is a prompt"
    },
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z"
  }
]

Retrieve a single funnel

get

Retrieve a funnel by its ID.

Path parameters

funnelIdstringRequired

The funnel's ID.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

Responses

200

A funnel.

application/json

idstringRequired

The funnel's ID.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

namestringRequired

The funnel's name.

Example: My Funnel

automation_idstringRequired

The funnel's automation ID.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

metadataobjectRequired

The funnel's metadata.

Example: {"prompt":"This is a prompt"}

created_atstring · date-timeRequired

Timestamp of when the funnel was created.

Example: 2025-01-01T00:00:00.000Z

updated_atstring · date-timeRequired

Timestamp of when the funnel was last updated.

Example: 2025-01-01T00:00:00.000Z

401

The user is not authenticated.

403

The user does not have permission to perform this operation.

get

/funnels/{funnelId}

HTTPcURLJavaScriptPython

GET /api/v1/funnels/{funnelId} HTTP/1.1
Accept: */*

{
  "id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "name": "My Funnel",
  "automation_id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "metadata": {
    "prompt": "This is a prompt"
  },
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}

Create a new funnel

post

Create a new funnel.

Body

application/json

namestringRequired

The funnel's name.

Example: My Funnel

promptstringRequired

The prompt used to generate the funnel.

Example: This is a prompt

themeobjectRequired

The funnel's theme.

Example: BOLD_AND_FUTURISTIC

Responses

201

The funnel that was created.

application/json

401

The user is not authenticated.

403

The user does not have permission to perform this operation.

post

/funnels

HTTPcURLJavaScriptPython

POST /api/v1/funnels HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "name": "My Funnel",
  "prompt": "This is a prompt",
  "theme": "BOLD_AND_FUTURISTIC"
}

{
  "id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "name": "My Funnel",
  "automation_id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "metadata": {
    "prompt": "This is a prompt"
  },
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}

Update a single funnel

patch

Update a funnel by its ID.

Path parameters

funnelIdstringRequired

The funnel's ID.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

Body

application/json

namestringRequired

The funnel's name.

Example: My Funnel

Responses

200

A funnel.

application/json

idstringRequired

The funnel's ID.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

namestringRequired

The funnel's name.

Example: My Funnel

automation_idstringRequired

The funnel's automation ID.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

metadataobjectRequired

The funnel's metadata.

Example: {"prompt":"This is a prompt"}

created_atstring · date-timeRequired

Timestamp of when the funnel was created.

Example: 2025-01-01T00:00:00.000Z

updated_atstring · date-timeRequired

Timestamp of when the funnel was last updated.

Example: 2025-01-01T00:00:00.000Z

401

The user is not authenticated.

403

The user does not have permission to perform this operation.

patch

/funnels/{funnelId}

HTTPcURLJavaScriptPython

PATCH /api/v1/funnels/{funnelId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "name": "My Funnel"
}

{
  "id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "name": "My Funnel",
  "automation_id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "metadata": {
    "prompt": "This is a prompt"
  },
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}

Delete a funnel

delete

Delete a funnel.

Path parameters

funnelIdstringRequired

The funnel's ID.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

Responses

200

The funnel that was deleted.

application/json

idstringRequired

The funnel's ID.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

namestringRequired

The funnel's name.

Example: My Funnel

automation_idstringRequired

The funnel's automation ID.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

metadataobjectRequired

The funnel's metadata.

Example: {"prompt":"This is a prompt"}

created_atstring · date-timeRequired

Timestamp of when the funnel was created.

Example: 2025-01-01T00:00:00.000Z

updated_atstring · date-timeRequired

Timestamp of when the funnel was last updated.

Example: 2025-01-01T00:00:00.000Z

401

The user is not authenticated.

403

The user does not have permission to perform this operation.

delete

/funnels/{funnelId}

HTTPcURLJavaScriptPython

DELETE /api/v1/funnels/{funnelId} HTTP/1.1
Accept: */*

{
  "id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "name": "My Funnel",
  "automation_id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "metadata": {
    "prompt": "This is a prompt"
  },
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}