# PromptLoop API

## Docs

- [API Overview](https://docs.promptloop.com/get-started/api-overview.md): Run AI tasks on large datasets with PromptLoop
- [CLI Quickstart](https://docs.promptloop.com/get-started/cli-quickstart.md): Install, authenticate, and run your first PromptLoop command in minutes
- [Introduction](https://docs.promptloop.com/get-started/introduction.md): Empower your team with AI-driven data tasks and business intelligence
- [Quickstart](https://docs.promptloop.com/get-started/quickstart.md): Start using PromptLoop to automate and enhance your data tasks in minutes
- [Concepts & Capabilities](https://docs.promptloop.com/get-started/task-concepts.md): Understanding PromptLoop tasks, web browsing capabilities, and the difference between batch and single job processing
- [Cancel Batch](https://docs.promptloop.com/v0.1/batches/cancel-batch.md): Cancels a running batch. This will mark the batch as cancelled and remove any pending jobs from the queue. Jobs that are already in progress will complete.
- [Create Batch](https://docs.promptloop.com/v0.1/batches/create-batch.md): Uploads a JSONL file and launches a new batch with the provided data. Returns the batch id.
- [Get All Batches](https://docs.promptloop.com/v0.1/batches/get-all-batches.md): Retrieves a list of the high-level metadata for all batches (paginated).
- [Get Batch](https://docs.promptloop.com/v0.1/batches/get-batch.md): Retrieves detailed metadata for the batch with provided id. This includes the batch status, job count, and other metadata.
- [Get Results](https://docs.promptloop.com/v0.1/batches/get-results.md): Get batch execution results once a batch reaches COMPLETED status. Receive the raw output or data to download depending on flag selection.
- [Retry Failed Jobs](https://docs.promptloop.com/v0.1/batches/retry-failed-jobs.md): Retries failed jobs in a batch. This will re-queue all failed jobs for processing. If the batch was cancelled, it will be reactivated.
- [Update batch metadata](https://docs.promptloop.com/v0.1/batches/update-batch-metadata.md): 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.
- [Validate Batch Data](https://docs.promptloop.com/v0.1/batches/validate-batch-data.md): Uploads a JSONL file and validates the data for a new batch with the provided data. Returns the batch id.
- [Create Task from Description](https://docs.promptloop.com/v0.1/tasks/create-task-from-description.md): Creates a new task from a natural language description. AI will generate the task definition based on your description.
- [Edit Task with Instruction](https://docs.promptloop.com/v0.1/tasks/edit-task-with-instruction.md): Edits an existing task with a natural language instruction. Creates a new version of the task.
- [Get All Tasks](https://docs.promptloop.com/v0.1/tasks/get-all-tasks.md): Retrieves a list of the high-level metadata for all tasks.
- [Get Task](https://docs.promptloop.com/v0.1/tasks/get-task.md): Retrieves detailed metadata for the task with provided id (inputs, outputs, etc.).
- [Quick Test Task](https://docs.promptloop.com/v0.1/tasks/quick-test-task.md): Quickly test a task with a single input. Useful for validating task behavior before running on full datasets.
- [Run Dynamic Task](https://docs.promptloop.com/v0.1/tasks/run-dynamic-task.md): Runs the dynamic research task with custom queries. Provide a website URL and a list of queries with optional formatting guidance and the task will return the enriched results.
- [Run Single Job](https://docs.promptloop.com/v0.1/tasks/run-single-job.md): 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.
- [Get Team Limits](https://docs.promptloop.com/v0.1/team/get-team-limits.md): Retrieves plan limits and configuration for the team including row limits, rate limiting status, and subscription details.
- [Get Team Usage](https://docs.promptloop.com/v0.1/team/get-team-usage.md): Retrieves usage statistics for the current billing period including rows processed, credits used, and credits remaining.

## OpenAPI Specs

- [openapi-v0](https://docs.promptloop.com/openapi-v0.json)
- [openapi-v0.1](https://docs.promptloop.com/openapi-v0.1.json)