Introduction

Use the PromptLayer REST API to manage prompts, workflows, evaluations, datasets, request logs, traces, and other workspace resources programmatically.

The PromptLayer REST API lets you interact with your workspace directly over HTTP so you can automate updates, run workflows, log activity, and export or organize data from your own systems.

Prefer a client library? See the Python SDK and JavaScript SDK. The complete machine-readable spec is available at openapi.json.

Authentication

Authenticate API requests with a PromptLayer API key using the X-API-Key header.

Generate API keys from the API keys page in your PromptLayer dashboard. Each workspace has its own API keys, and requests use the workspace associated with the key by default.

Endpoints

Prompt Templates

• Get Prompt Template
• Get Prompt Template (Raw)
• List Prompt Templates
• Publish Prompt Template
• Patch Prompt Template Version
• List Prompt Template Labels
• Create Prompt Template Label
• Move Prompt Template Label
• Delete Prompt Template Label
• Get Snippet Usage

Tracking

• Get Request
• Search Request Logs
• Log Request
• Track Prompt
• Track Score
• Track Metadata
• Create Spans Bulk
• Ingest Traces (OTLP)
• Get Trace
• Close Trace
• Request Analytics
• Request Analytics — Custom Queries
• Search Request Suggestions

Datasets

Dataset endpoints are deprecated for new workflows. Use Tables and Table sheet imports instead.

• List Datasets
• Get Dataset Rows
• Create Dataset Group
• Create Dataset Version from File
• Create Dataset Version from Filter Params
• Create Draft Dataset Version
• Save Draft Dataset Version
• Add Request Log to Dataset
• Add Trace to Dataset

Evaluations

Evaluation and Report endpoints are deprecated for new workflows. Use Tables, Table operations, and Table sheet scoring instead.

• List Evaluations
• Get Evaluation Rows
• Create Evaluation Pipeline
• Run Report
• Get Report
• Get Report Score
• Add Report Columns
• Edit Evaluation Pipeline Column
• Delete Evaluation Pipeline Column
• Update Report Score Card
• Rename Evaluation Pipeline
• Delete Evaluation Pipeline
• Delete Reports by Name

Tables

Table endpoints are scoped to the workspace associated with your API key. Sheet read responses include version_count; sheet mutations that create a new sheet version return version, the current sheet version count after the operation.

• Create Table
• List Tables
• Get Table
• Update Table
• Delete Table
• List Sheets
• Create Sheet
• Import File
• Import Request Logs
• Get Sheet Import Operation
• Get Sheet
• Update Sheet
• Delete Sheet
• List Columns
• Create Column
• Update Column
• Delete Column
• List Rows
• Add Rows
• Get Cell
• Update Cell
• Recalculate Cell
• Recalculate Cells
• List Operations
• Create Operation
• Get Operation
• Cancel Operation
• Get Score
• Configure Score
• Recalculate Score
• List Versions
• Create Version
• Get Version
• Get Score History

Pass folder_id on Create Evaluation Pipeline, Create Table, and the create endpoints under Prompt Templates, Datasets, and Workflows to organize new resources directly into a folder. Use Resolve Folder ID by Path to look up an ID, or Create Folder to make one. See Unified Registry.

Workflows

• List Workflows
• Get Workflow
• Get Workflow Labels
• Create Workflow
• Update Workflow
• Run Workflow
• Get Workflow Version Execution Results

Skill Collections

• List Skill Collections
• Create Skill Collection
• Get Skill Collection
• Update Skill Collection
• Save Skill Collection Version

Tool Registry

• List Tool Registries
• Get Tool Registry
• Create Tool Registry
• Create Tool Version
• Test Execute Tool

Environment Variables

• List Workspace Env Vars
• Create Workspace Env Var
• Update Workspace Env Var
• Delete Workspace Env Var
• List Tool Env Vars
• Create Tool Env Var
• Update Tool Env Var
• Delete Tool Env Var

External IDs

Attach your own identifiers to PromptLayer resources so you can reference them by external ID. See the External IDs overview for details. Attach, list, and delete operations are available for:

• Prompt Templates (plus upsert)
• Workflows
• Folders
• Reports
• Dataset Groups
• Skill Collections
• Tool Registries

Unified Registry

• Create Folder
• Update Folder
• List Folder Entities
• Move Folder Entities
• Delete Folder Entities
• Resolve Folder ID by Path