> ## Documentation Index
> Fetch the complete documentation index at: https://docs.promptloop.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

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

## Welcome to the PromptLoop API

This API provides access to [PromptLoop](https://promptloop.com) functionality.

PromptLoop is an AI platform that lets you:

* Enrich company datasets with AI web research
* Build proprietary Go-To-Market datasets for Sales & Marketing
* Automate repeatable AI transformations on spreadsheet text data
* Scrape and extract structured data from websites and lists

## Account Set up

To use the API, you will need access to a PromptLoop account. You can sign up for a free trial and if you are interested
in building with the api you can reach out to [team@promptloop.com](mailto:team@promptloop.com).

* Create an account on [PromptLoop.com](https://promptloop.com)
* Follow the guides to create an AI agent to run [(A PromptLoop Task)](https://www.promptloop.com/docs/getting-started)
* Create an API key at [settings page](https://promptloop.com/account/settings)

<Note>
  The API lets you run existing PromptLoop Tasks so you will need to set them up
  there before running the API
</Note>

## Run a single Job

Once you have a task and a task ID, you can provide an input and get back live data just like you would on the PromptLoop Platform.

**Request**

```bash Request theme={null}
curl --request POST \
  --url https://api.promptloop.com/v0.1/tasks/YOUR_TASK_ID \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '{
  "task_version": 0,
  "inputs": [
    "promptloop.com"
  ]
}'
```

**Response**

```bash Response theme={null}
{
  "status": "success",
  "data": {
    "job_id": "6497b030-f841-4421-ab39-7e0c16e83ee6",
    "error_detected": false,
    "list": false,
    "data_json": {
      "Site Description": "PromptLoop is an AI platform for GTM and B2B sales that automates web scraping, deep research, and CRM data enrichment, providing accurate B2B insights to make research 10 times faster.",
      "Contact Email": "team@promptloop.com"
    },
    "list_data_json": null
  },
  "message": "",
  "error": null,
  "request_id": "9e56405e-f910-43ae-ad95-d2d09ad83909"
}
```

<Note>
  Most of the time you will be using Batch APIs - which amount to sending a set
  of inputs like this example at once and receiving a webhook
</Note>

Once you send your first request you are off to a great start!

<RequestExample>
  ```bash Request theme={null}
  curl --request POST \
    --url https://api.promptloop.com/v0.1/tasks/YOUR_TASK_ID \
    --header 'Content-Type: application/json' \
    --header 'x-api-key: YOUR_API_KEY' \
    --data '{
    "task_version": 0,
    "inputs": [
      "promptloop.com"
    ]
  }'
  ```

  Response

  ```bash Response theme={null}
  {
    "status": "success",
    "data": {
      "job_id": "6497b030-f841-4421-ab39-7e0c16e83ee6",
      "error_detected": false,
      "list": false,
      "data_json": {
        "Site Description": "PromptLoop is an AI platform for GTM and B2B sales that automates web scraping, deep research, and CRM data enrichment, providing accurate B2B insights to make research 10 times faster.",
        "Contact Email": "team@promptloop.com"
      },
      "list_data_json": null
    },
    "message": "",
    "error": null,
    "request_id": "9e56405e-f910-43ae-ad95-d2d09ad83909"
  }
  ```
</RequestExample>

## Continued: Core PromptLoop Concepts

<AccordionGroup>
  <Accordion icon="list-check" title="Tasks">
    Tasks are actions for our systems to accomplish for you. They consist of
    inputs (like a website or search item) and return outputs as new columns or
    rows of data.
  </Accordion>

  <Accordion icon="database" title="Datasets">
    Datasets are repositories for your information. You can search, filter,
    save, and share inputs and outputs from AI tasks up to hundreds of thousands
    of rows.
  </Accordion>

  <Accordion icon="table" title="API Endpoints">
    The PromptLoop API lets you launch and monitor jobs to enrich data and
    create Datasets
  </Accordion>
</AccordionGroup>

## Generate and API Access

Teams on PromptLoop enterprise plans can access our core API:

<CardGroup>
  <Card title="API Access" icon="wand-magic-sparkles" href="https://promptloop.com/account/settings">
    Create custom AI-powered content generation workflows.
  </Card>
</CardGroup>

These features can be enabled and managed in your team's settings page.

## Learn More

<CardGroup>
  <Card title="Custom Tasks" icon="wand-magic-sparkles" href="https://promptloop.com/account/custom">
    Learn how to create and modify tasks to suit your needs.
  </Card>

  <Card title="Datasets" icon="database" href="https://promptloop.com/account/datasets">
    Understand how to manage and utilize datasets effectively.
  </Card>

  <Card title="Spreadsheet Integration" icon="table" href="https://promptloop.com/account/settings">
    Explore how to use PromptLoop with Excel and Google Sheets.
  </Card>

  <Card title="Book a Demo" icon="calendar" href="https://promptloop.com/demo">
    Get personalized support for your specific business needs.
  </Card>
</CardGroup>