---
canonical_url: "https://docs.composio.dev/toolkits/promptlayer"
markdown_url: "https://docs.composio.dev/toolkits/promptlayer.md"
product: "platform"
version: null
last_updated: null
---

# PromptLayer

PromptLayer is a prompt management and observability platform for versioning, evaluating, running, and analyzing LLM applications.

- **Category:** artificial intelligence
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 16
- **Triggers:** 0
- **Slug:** `PROMPTLAYER`
- **Version:** 00000000_00

## Tools

### Get Prompt Template

**Slug:** `PROMPTLAYER_GET_PROMPT_TEMPLATE`

Retrieve a prompt template version, release label, messages, model metadata, snippets, and optionally provider-ready kwargs without executing it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | No | Release label to resolve, such as production or staging. Cannot be used with version. |
| `version` | integer | No | Specific positive version number. Cannot be used with label. |
| `identifier` | string | Yes | Prompt-template name or numeric ID. |
| `resolve_snippets` | boolean | No | Whether to expand snippet references in the returned template. |
| `include_llm_kwargs` | boolean | No | Whether to include provider-specific kwargs derived from the template's model metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Registered Tool

**Slug:** `PROMPTLAYER_GET_REGISTERED_TOOL`

Retrieve a PromptLayer registered tool definition by ID or name at a selected version or release label without test execution.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | No | Release label to resolve; mutually exclusive with version. |
| `version` | string | No | Specific version to resolve; mutually exclusive with label. |
| `identifier` | string | Yes | Registered tool's numeric ID or name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Request Log

**Slug:** `PROMPTLAYER_GET_REQUEST_LOG`

Retrieve one PromptLayer request log with its recorded input, output, timing, usage, metadata, tags, and scores.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_id` | integer | Yes | PromptLayer request-log ID returned by request-log search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Skill Collection

**Slug:** `PROMPTLAYER_GET_SKILL_COLLECTION`

Retrieve a PromptLayer skill collection and its files as JSON at a selected version or release label.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | No | Release label to resolve; mutually exclusive with version. |
| `version` | integer | No | Positive version number to retrieve; mutually exclusive with label. |
| `identifier` | string | Yes | Skill collection UUID, name, or root path. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Table

**Slug:** `PROMPTLAYER_GET_TABLE`

Retrieve one PromptLayer Table's metadata and per-sheet row counts by UUID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `table_id` | string | Yes | Table UUID returned by list tables. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workflow

**Slug:** `PROMPTLAYER_GET_WORKFLOW`

Retrieve a PromptLayer workflow definition by ID or name at a specific version or release label without running it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | No | Release label to resolve; mutually exclusive with version. |
| `version` | integer | No | Specific positive version to retrieve; mutually exclusive with label. |
| `workflow_id_or_name` | string | Yes | Workflow ID or name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Folder Entities

**Slug:** `PROMPTLAYER_LIST_FOLDER_ENTITIES`

Browse or search PromptLayer folders and registry entities in the API-key workspace, optionally recursively and with metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Tags used to filter entity types that support tags. Accepts one or more tags. |
| `flatten` | boolean | No | Return descendants recursively instead of direct children only. |
| `sort_by` | string ("created_at" | "updated_at" | "name" | "id") | No | Sort by created_at, updated_at, name, or id. |
| `folder_id` | integer | No | Folder to browse; omit for the workspace root. |
| `sort_order` | string ("asc" | "desc") | No | Sort direction: asc or desc. |
| `external_id` | string | No | External-ID value; provide together with external_source. |
| `filter_types` | array | No | Entity types to include. Accepts one or more of FOLDER, PROMPT, SNIPPET, WORKFLOW, DATASET, REPORT, AB_TEST, or INPUT_VARIABLE_SET. |
| `search_query` | string | No | Case-insensitive partial entity-name search. |
| `external_source` | string | No | External-ID source; provide together with external_id. |
| `created_by_email` | string | No | Creator email to match exactly. |
| `include_metadata` | boolean | No | Include type-specific metadata such as prompt type and latest version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Prompt Templates

**Slug:** `PROMPTLAYER_LIST_PROMPT_TEMPLATES`

Search and page through PromptLayer prompt templates and snippets without executing a model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Case-insensitive partial prompt-template name. |
| `tags` | array | No | Tags that every returned template must contain. Accepts one tag or a list. |
| `label` | string | No | Release label such as production or staging. |
| `status` | string ("active" | "deleted" | "all") | No | Template status to return. |
| `sort_by` | string ("created_at" | "updated_at" | "name" | "id") | No | Field used to sort templates. |
| `per_page` | integer | No | Maximum templates in this page (1-100). |
| `is_snippet` | boolean | No | True for snippets only, false to exclude snippets, or omit for both. |
| `sort_order` | string ("asc" | "desc") | No | Sort direction. |
| `external_id` | string | No | External-ID value. Provide together with external_source. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. |
| `created_after` | string | No | Return templates created at or after this timestamp. |
| `updated_after` | string | No | Return templates updated at or after this timestamp. |
| `created_before` | string | No | Return templates created at or before this timestamp. |
| `updated_before` | string | No | Return templates updated at or before this timestamp. |
| `external_source` | string | No | External-ID source. Provide together with external_id. |
| `created_by_email` | string | No | Creator email to match exactly. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Registered Tools

**Slug:** `PROMPTLAYER_LIST_REGISTERED_TOOLS`

List and filter tools defined in PromptLayer's tool registry without executing them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string ("created_at" | "updated_at" | "name" | "id") | No | Sort by created_at, updated_at, name, or id. |
| `sort_order` | string ("asc" | "desc") | No | Sort direction: asc or desc. |
| `external_id` | string | No | External-ID value; provide together with external_source. |
| `created_after` | string | No | Return tools created at or after this timestamp. |
| `updated_after` | string | No | Return tools updated at or after this timestamp. |
| `created_before` | string | No | Return tools created at or before this timestamp. |
| `updated_before` | string | No | Return tools updated at or before this timestamp. |
| `external_source` | string | No | External-ID source; provide together with external_id. |
| `created_by_email` | string | No | Creator email to match exactly. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Skill Collections

**Slug:** `PROMPTLAYER_LIST_SKILL_COLLECTIONS`

List and filter PromptLayer skill collections available in the API-key workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string ("created_at" | "updated_at" | "name" | "id") | No | Sort by created_at, updated_at, name, or id. |
| `sort_order` | string ("asc" | "desc") | No | Sort direction: asc or desc. |
| `external_id` | string | No | External-ID value; provide together with external_source. |
| `created_after` | string | No | Return collections created at or after this timestamp. |
| `updated_after` | string | No | Return collections updated at or after this timestamp. |
| `created_before` | string | No | Return collections created at or before this timestamp. |
| `updated_before` | string | No | Return collections updated at or before this timestamp. |
| `external_source` | string | No | External-ID source; provide together with external_id. |
| `created_by_email` | string | No | Creator email to match exactly. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Table Columns

**Slug:** `PROMPTLAYER_LIST_TABLE_COLUMNS`

List one page of user and optionally system columns for a PromptLayer Table sheet.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum columns in this page (1-100). |
| `sheet_id` | string | Yes | Sheet UUID returned by list table sheets. |
| `table_id` | string | Yes | Parent Table UUID. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. |
| `include_system_columns` | boolean | No | Include system-managed price, latency, and prompt-output metadata columns. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Table Rows

**Slug:** `PROMPTLAYER_LIST_TABLE_ROWS`

Read one page of rows and cells from a PromptLayer Table sheet, with optional schema and execution aggregates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum rows in this page (1-100). |
| `order` | string ("asc" | "desc") | No | Row order. |
| `sheet_id` | string | Yes | Sheet UUID returned by list table sheets. |
| `table_id` | string | Yes | Parent Table UUID. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. |
| `include_columns` | boolean | No | Include column metadata alongside rows. |
| `include_row_count` | boolean | No | Include the total row count. |
| `include_system_columns` | boolean | No | Include system-managed price, latency, and prompt-output columns. |
| `include_execution_metadata_aggregates` | boolean | No | Include sheet and per-column price and latency aggregates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tables

**Slug:** `PROMPTLAYER_LIST_TABLES`

Search and page through PromptLayer Tables by folder, name, or referenced prompt.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Case-insensitive partial Table title. |
| `limit` | integer | No | Maximum Tables in this page (1-100). |
| `order` | string ("asc" | "desc") | No | Sort direction. |
| `folder_id` | integer | No | Only Tables in this folder. |
| `prompt_id` | integer | No | Only Tables with a column referencing this prompt. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. |
| `prompt_label_id` | integer | No | Only Tables referencing this prompt label. |
| `prompt_version_id` | integer | No | Only Tables referencing this prompt version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Table Sheets

**Slug:** `PROMPTLAYER_LIST_TABLE_SHEETS`

List one page of sheets in a PromptLayer Table, optionally filtering by referenced prompt.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum sheets in this page (1-100). |
| `order` | string ("asc" | "desc") | No | Sort direction. |
| `table_id` | string | Yes | Parent Table UUID. |
| `prompt_id` | integer | No | Only sheets with a column referencing this prompt. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. |
| `prompt_label_id` | integer | No | Only sheets referencing this prompt label. |
| `prompt_version_id` | integer | No | Only sheets referencing this prompt version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workflows

**Slug:** `PROMPTLAYER_LIST_WORKFLOWS`

Search and page through PromptLayer workflows without running them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string ("created_at" | "updated_at" | "name" | "id") | No | Sort by created_at, updated_at, name, or id. |
| `per_page` | integer | No | Maximum workflows in this page (1-100). |
| `sort_order` | string ("asc" | "desc") | No | Sort direction: asc or desc. |
| `external_id` | string | No | External-ID value; provide together with external_source. |
| `next_cursor` | string | No | Continuation cursor returned by a previous response. Omit for the first page and pass it back unchanged to fetch the next page. |
| `created_after` | string | No | Return workflows created at or after this timestamp. |
| `updated_after` | string | No | Return workflows updated at or after this timestamp. |
| `created_before` | string | No | Return workflows created at or before this timestamp. |
| `updated_before` | string | No | Return workflows updated at or before this timestamp. |
| `external_source` | string | No | External-ID source; provide together with external_id. |
| `created_by_email` | string | No | Creator email to match exactly. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Request Logs

**Slug:** `PROMPTLAYER_SEARCH_REQUEST_LOGS`

Search PromptLayer request logs by text or structured filters and return one rate-limited page sorted by operational fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Free-text fuzzy-prefix search across prompt input and model output. |
| `sort_by` | string ("request_start_time" | "input_tokens" | "output_tokens" | "cost" | "latency_ms" | "status") | No | Operational field used to sort results. |
| `per_page` | integer | No | Maximum request logs to return on this page (1-25). |
| `sort_order` | string ("asc" | "desc") | No | Result sort direction. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |
| `filter_group` | object | No | Structured AND/OR filter group for request-log fields. |
| `include_prompt_name` | boolean | No | Include the associated prompt-template name in each result. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |