API Reference

Docs Setup guide

Platform Guides

PromptLoop API

Dashboard

Support

Retrieves detailed metadata for the batch with provided id. This includes the batch status, job count, and other metadata.

Get Batch

x api key

Empower your team with AI-driven data tasks and business intelligence

Introduction

Start using PromptLoop to automate and enhance your data tasks in minutes

Getting Started

Run AI tasks on large datasets with PromptLoop

API Overview

Retrieves a list of the high-level metadata for all tasks.

Get All Tasks

Retrieves detailed metadata for the task with provided id (inputs, outputs, etc.).

Get Task

Runs a single job with the provided task and inputs and awaits the result. Tasks have a default timeout of 1 minute. For longer running tasks, consider using async batches instead.

Run Single Job

Retrieves a list of the high-level metadata for all batches (paginated).

Get All Batches

Uploads a JSONL file and launches a new batch with the provided data. Returns the batch id.

Create Batch

Uploads a JSONL file and validates the data for a new batch with the provided data. Returns the batch id.

Validate Batch Data

Updates user-defined metadata fields for the batch with provided id. This includes the webhook_url. Explicitly passing an empty string for webhook_url to the request body will remove/clear any webhook url from the batch.

Update batch metadata

Get batch execution results once a batch reaches COMPLETED status. Receive the raw output or data to download depending on flag selection.

Tasks

Batches

Get Batch

Authorizations

Path Parameters

Response