Parse

https://docs.parse.bot/
Admin
Parse is a platform that converts any website into a structured, callable API, handling scraping,...
Tokens:78,017
Snippets:528
Trust Score:6.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### Go example for SDK usage

Source: https://docs.parse.bot/api-reference/dispatch/get-sdk-usage-example

Uses net/http to GET the SDK example. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.parse.bot/dispatch/tasks/{task_id}/sdk-example"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### GET /dispatch/tasks/{task_id}/sdk-example

Source: https://docs.parse.bot/api-reference/dispatch/get-sdk-usage-example

Fetches an SDK usage example for the specified task. The response includes example code and related endpoints.

```APIDOC
## GET /dispatch/tasks/{task_id}/sdk-example

### Description
Retrieves an SDK usage example for a specific dispatch task. The response includes example code and related endpoints.

### Method
GET

### Endpoint
https://api.parse.bot/dispatch/tasks/{task_id}/sdk-example

### Parameters
#### Path Parameters
- **task_id** (string) - Required - The ID of the task.

#### Headers
- **X-API-Key** (string) - Required - API key for programmatic access. Create one in the Parse dashboard at https://parse.bot (Settings → API Keys). Keys start with 'pmx_'.

### Response
#### Success Response (200)
- **sdk_usage_example** (object | null) - Contains the SDK usage example details.
  - **code** (string) - The example code.
  - **endpoints** (array of string) - List of related endpoints.
  - **has_session** (boolean) - Indicates if a session is present.

#### Response Example
```json
{
  "sdk_usage_example": {
    "code": "<string>",
    "endpoints": [
      "<string>"
    ],
    "has_session": true
  }
}
```
```

--------------------------------

### Ruby Net::HTTP example for SDK usage

Source: https://docs.parse.bot/api-reference/dispatch/get-sdk-usage-example

Uses Net::HTTP to GET the SDK example. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.parse.bot/dispatch/tasks/{task_id}/sdk-example")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Java Unirest example for SDK usage

Source: https://docs.parse.bot/api-reference/dispatch/get-sdk-usage-example

Uses Unirest to GET the SDK example. Requires the Unirest library.

```java
HttpResponse<String> response = Unirest.get("https://api.parse.bot/dispatch/tasks/{task_id}/sdk-example")
  .header("X-API-Key", "<api-key>")
  .asString();
```

--------------------------------

### Go example

Source: https://docs.parse.bot/api-reference/dispatch/list-your-apis

Uses net/http to GET the dispatch tasks endpoint with an X-API-Key header and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.parse.bot/dispatch/tasks?limit=50"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### JavaScript fetch example for SDK usage

Source: https://docs.parse.bot/api-reference/dispatch/get-sdk-usage-example

Uses fetch to GET the SDK example and logs the JSON response. Requires a browser or Node.js with fetch support.

```javascript
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.parse.bot/dispatch/tasks/{task_id}/sdk-example', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Go example for marketplace API detail

Source: https://docs.parse.bot/api-reference/marketplace/get-a-marketplace-apis-detail

Uses the net/http package to send a GET request and prints the response body. No authentication is required.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.parse.bot/marketplace/apis/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### List marketplace APIs with GET request

Source: https://docs.parse.bot/api-reference/marketplace/search-and-browse-the-marketplace

These examples show how to make a GET request to the marketplace endpoint to list available APIs. Each snippet uses a different language or tool, but all target the same URL and method.

```bash
curl --request GET \
  --url https://api.parse.bot/marketplace/apis
```

```python
import requests

url = "https://api.parse.bot/marketplace/apis"

response = requests.get(url)

print(response.text)
```

```javascript
const options = {method: 'GET'};

fetch('https://api.parse.bot/marketplace/apis', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.parse.bot/marketplace/apis",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.parse.bot/marketplace/apis"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.get("https://api.parse.bot/marketplace/apis")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.parse.bot/marketplace/apis")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

--------------------------------

### Python requests example for SDK usage

Source: https://docs.parse.bot/api-reference/dispatch/get-sdk-usage-example

Uses the requests library to GET the SDK example. Requires the requests package and an API key.

```python
import requests

url = "https://api.parse.bot/dispatch/tasks/{task_id}/sdk-example"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Go example for listing revision history

Source: https://docs.parse.bot/api-reference/dispatch/list-revision-history

Uses net/http to send a GET request with the X-API-Key header. Reads and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.parse.bot/dispatch/tasks/{task_id}/revisions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### PHP cURL example for SDK usage

Source: https://docs.parse.bot/api-reference/dispatch/get-sdk-usage-example

Uses PHP cURL to GET the SDK example. Handles errors and prints the response.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.parse.bot/dispatch/tasks/{task_id}/sdk-example",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Go net/http example

Source: https://docs.parse.bot/api-reference/dispatch/get-the-in-flight-task-for-a-scraper

Go example using net/http to fetch the in-flight task. Replace {scraper_id} and <api-key> with your values.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.parse.bot/dispatch/scrapers/{scraper_id}/active-task"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### cURL request to get SDK usage example

Source: https://docs.parse.bot/api-reference/dispatch/get-sdk-usage-example

Uses cURL to send a GET request to the endpoint with the X-API-Key header. Replace {task_id} and <api-key> with actual values.

```bash
curl --request GET \
  --url https://api.parse.bot/dispatch/tasks/{task_id}/sdk-example \
  --header 'X-API-Key: <api-key>'
```

--------------------------------

### JavaScript fetch example

Source: https://docs.parse.bot/api-reference/dispatch/get-the-in-flight-task-for-a-scraper

JavaScript example using fetch to get the in-flight task. Replace {scraper_id} and <api-key> with your values.

```javascript
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.parse.bot/dispatch/scrapers/{scraper_id}/active-task', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Go net/http example for rollback-merge

Source: https://docs.parse.bot/api-reference/dispatch/rollback-last-merge

Go example using net/http to POST to the rollback-merge endpoint. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.parse.bot/dispatch/tasks/{task_id}/rollback-merge"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Ruby Net::HTTP example for marketplace API detail

Source: https://docs.parse.bot/api-reference/marketplace/get-a-marketplace-apis-detail

Uses Net::HTTP to send a GET request over SSL and prints the response body. No authentication is required.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.parse.bot/marketplace/apis/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

--------------------------------

### Python requests example

Source: https://docs.parse.bot/api-reference/dispatch/list-your-apis

Uses the requests library to GET the dispatch tasks endpoint with an X-API-Key header and prints the response text.

```python
import requests

url = "https://api.parse.bot/dispatch/tasks?limit=50"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Java Unirest example for listing revision history

Source: https://docs.parse.bot/api-reference/dispatch/list-revision-history

Uses Unirest to send a GET request with the X-API-Key header and returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://api.parse.bot/dispatch/tasks/{task_id}/revisions")
  .header("X-API-Key", "<api-key>")
  .asString();
```

--------------------------------

### Setup prompt for coding agents

Source: https://docs.parse.bot/sdk

Paste this prompt into Claude Code, Codex, or any coding agent to set up and use the Parse Python SDK end to end. It covers project initialization, SDK installation, authentication, API listing and adding, and running code. Always invoke the CLI as `uv run parse …` and prefer `--json` output when parsing results.

```text
Set up and use the Parse Python SDK in this project.

1. Ensure this is a uv project — if there is no pyproject.toml, run `uv init`.
2. Install the SDK: `uv add parse-sdk`.
3. Authenticate: if PARSE_API_KEY is not set, get a key from the Parse
   dashboard (parse.bot → Settings → API Keys) and run
   `uv run parse login --api-key <KEY>`.
4. Initialize: `uv run parse init` (now non-interactive — credentials exist).
5. List the APIs this key can call: `uv run parse list --json`.
6. Add the API(s) I need by slug: `uv run parse add <slug>` (or
   `uv run parse add --marketplace <id|slug|url>` for a marketplace API).
   This regenerates parse_apis.
7. Read `parse_apis/src/parse_apis/<slug>/README.md` for the exact import line, then write
   code that imports the typed client from `parse_apis.<module>` and calls its
   resources and methods. Catch typed errors re-exported from `parse_apis`.
8. Run it with `uv run python <file>.py`.

Always invoke the CLI as `uv run parse …`. Prefer `--json` output when parsing
results. If imports or editor autocomplete don't resolve, run
`uv run parse doctor --fix`.

```

--------------------------------

### Ruby Net::HTTP example

Source: https://docs.parse.bot/api-reference/dispatch/list-your-apis

Uses Net::HTTP to GET the dispatch tasks endpoint with an X-API-Key header and prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.parse.bot/dispatch/tasks?limit=50")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Ruby Net::HTTP example for listing revision history

Source: https://docs.parse.bot/api-reference/dispatch/list-revision-history

Uses Net::HTTP to send a GET request with SSL enabled and the X-API-Key header. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.parse.bot/dispatch/tasks/{task_id}/revisions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Java Unirest example

Source: https://docs.parse.bot/api-reference/dispatch/get-the-in-flight-task-for-a-scraper

Java example using Unirest to fetch the in-flight task. Replace {scraper_id} and <api-key> with your values.

```java
HttpResponse<String> response = Unirest.get("https://api.parse.bot/dispatch/scrapers/{scraper_id}/active-task")
  .header("X-API-Key", "<api-key>")
  .asString();
```

--------------------------------

### Java Unirest example for marketplace API detail

Source: https://docs.parse.bot/api-reference/marketplace/get-a-marketplace-apis-detail

Uses the Unirest HTTP library to send a GET request and returns the response as a string. No authentication is required.

```java
HttpResponse<String> response = Unirest.get("https://api.parse.bot/marketplace/apis/{id}")
  .asString();
```

--------------------------------

### Python requests example

Source: https://docs.parse.bot/api-reference/dispatch/get-the-in-flight-task-for-a-scraper

Python example using the requests library to fetch the in-flight task. Replace {scraper_id} and <api-key> with your values.

```python
import requests

url = "https://api.parse.bot/dispatch/scrapers/{scraper_id}/active-task"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Ruby Net::HTTP example

Source: https://docs.parse.bot/api-reference/dispatch/get-the-in-flight-task-for-a-scraper

Ruby example using Net::HTTP to fetch the in-flight task. Replace {scraper_id} and <api-key> with your values.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.parse.bot/dispatch/scrapers/{scraper_id}/active-task")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Python requests example for rollback-merge

Source: https://docs.parse.bot/api-reference/dispatch/rollback-last-merge

Python example using the requests library to POST to the rollback-merge endpoint. Prints the response text.

```python
import requests

url = "https://api.parse.bot/dispatch/tasks/{task_id}/rollback-merge"

headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)
```

--------------------------------

### PHP cURL example

Source: https://docs.parse.bot/api-reference/dispatch/get-the-in-flight-task-for-a-scraper

PHP example using cURL to fetch the in-flight task. Replace {scraper_id} and <api-key> with your values.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.parse.bot/dispatch/scrapers/{scraper_id}/active-task",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Ruby Net::HTTP example for rollback-merge

Source: https://docs.parse.bot/api-reference/dispatch/rollback-last-merge

Ruby example using Net::HTTP to POST to the rollback-merge endpoint. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.parse.bot/dispatch/tasks/{task_id}/rollback-merge")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Get task detail with Ruby Net::HTTP

Source: https://docs.parse.bot/api-reference/dispatch/get-task-detail

Ruby example using Net::HTTP to GET the task detail endpoint. Requires an API key (starts with 'pmx_') passed in the X-API-Key header. Replace {task_id} with the actual task identifier.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.parse.bot/dispatch/tasks/{task_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Install parse-sdk and initialize project

Source: https://docs.parse.bot/sdk

Adds the parse-sdk runtime and CLI to your uv project, then runs parse init to authenticate, scaffold the parse_apis package, and perform the first sync. Run from the project root where pyproject.toml is located.

```bash
uv add parse-sdk      # runtime + `parse` CLI, into your project's .venv
uv run parse init     # one-time: authenticate, scaffold parse_apis, first sync

```

--------------------------------

### Go example for previewing an endpoint update

Source: https://docs.parse.bot/api-reference/dispatch/preview-an-endpoint-update

Uses net/http to POST a JSON string with an empty params object. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name}"

	payload := strings.NewReader("{\n  \"params\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Go example to create a new API from a URL

Source: https://docs.parse.bot/api-reference/dispatch/create-a-new-api-from-a-url

Uses net/http to POST a JSON payload to the dispatch endpoint. Sets X-API-Key and Content-Type headers, then prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.parse.bot/dispatch"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"task\": \"<string>\",\n  \"contributes_to_marketplace\": true,\n  \"allow_auth\": false,\n  \"workspace\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Response 200 for SDK usage example

Source: https://docs.parse.bot/api-reference/dispatch/get-sdk-usage-example

Example JSON response for a successful request. Contains sdk_usage_example object with code, endpoints, and has_session fields.

```json
{
  "sdk_usage_example": {
    "code": "<string>",
    "endpoints": [
      "<string>"
    ],
    "has_session": true
  }
}
```

--------------------------------

### Ruby example to create a new API from a URL

Source: https://docs.parse.bot/api-reference/dispatch/create-a-new-api-from-a-url

Uses Net::HTTP to POST the payload to the dispatch endpoint. Sets X-API-Key and Content-Type headers, then prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.parse.bot/dispatch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"task\": \"<string>\",\n  \"contributes_to_marketplace\": true,\n  \"allow_auth\": false,\n  \"workspace\": false\n}"

response = http.request(request)
puts response.read_body
```

--------------------------------

### 200 response body for get task detail

Source: https://docs.parse.bot/api-reference/dispatch/get-task-detail

Example 200 response body for the get task detail endpoint. Shows the structure of a task object, including status, iteration, generated API details, and endpoint definitions.

```json
{
  "id": "<string>",
  "url": "<string>",
  "task": "<string>",
  "status": "queued",
  "iteration": 123,
  "user_input_prompt": {},
  "result_scraper_id": "<string>",
  "result_marketplace_id": "<string>",
  "error": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "completed_at": "<string>",
  "parent_task_id": "<string>",
  "extends_scraper_id": "<string>",
  "revision_type": "<string>",
  "auth_enabled": false,
  "source": "built",
  "contributes_to_marketplace": true,
  "progress": {},
  "marketplace_apis": {},
  "existing_marketplace_apis": {},
  "generated_api": {
    "marketplace_id": "<string>",
    "scraper_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "source_url": "<string>",
    "execution_base_url": "<string>",
    "endpoints": [
      {
        "method": "<string>",
        "endpoint_name": "<string>",
        "description": "<string>",
        "input_params": {},
        "return_schema": {},
        "initiates_session": true
      }
    ]
  }
}
```

--------------------------------

### Java Unirest example

Source: https://docs.parse.bot/api-reference/dispatch/list-your-apis

Uses Unirest to GET the dispatch tasks endpoint with an X-API-Key header and returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://api.parse.bot/dispatch/tasks?limit=50")
  .header("X-API-Key", "<api-key>")
  .asString();
```

--------------------------------

### parse init

Source: https://docs.parse.bot/sdk

One-time setup command that authenticates, scaffolds the parse_apis directory, records dependencies, and performs the first sync.

```APIDOC
## parse init

### Description
One-time setup: authenticate, scaffold `parse_apis`, record deps, first sync.

### Command
`parse init [--api-key K] [--base-url U]`

### Parameters
#### Options
- `--api-key K` (string) - Optional - API key to use for authentication.
- `--base-url U` (string) - Optional - Base URL for the API.

### Usage
Run as `uv run parse init` or `parse init` in an activated venv.
```

--------------------------------

### PHP cURL example

Source: https://docs.parse.bot/api-reference/dispatch/list-your-apis

Uses PHP cURL to GET the dispatch tasks endpoint with an X-API-Key header, handling errors and printing the response.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.parse.bot/dispatch/tasks?limit=50",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Go example for merge-updates

Source: https://docs.parse.bot/api-reference/dispatch/merge-updates-from-canonical

Uses net/http to send a POST request with a JSON body and headers. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.parse.bot/dispatch/tasks/{task_id}/merge-updates"

	payload := strings.NewReader("{\n  \"endpoints\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Full Python example: login and call protected endpoint with httpx

Source: https://docs.parse.bot/authenticated-apis

Logs in to obtain session_id and encryption_key, then calls a protected endpoint using those credentials in headers. Uses httpx client with a 60-second timeout.

```python
import httpx

API_KEY = "your-api-key"
BASE = "https://api.parse.bot"
HEADERS = {"X-API-Key": API_KEY, "Content-Type": "application/json"}

scraper_id = "scraper-456"

with httpx.Client(headers=HEADERS, timeout=60) as client:
    # 1. Login
    resp = client.post(f"{BASE}/scraper/{scraper_id}/login", json={
        "username": "user@example.com",
        "password": "s3cret",
    })
    login = resp.json()
    session_id = login["session_id"]
    encryption_key = login["encryption_key"]

    # 2. Call a protected endpoint
    resp = client.post(
        f"{BASE}/scraper/{scraper_id}/get_inbox",
        headers={
            **HEADERS,
            "X-Session-ID": session_id,
            "X-Encryption-Key": encryption_key,
        },
        json={"folder": "inbox", "limit": 10},
    )
    print(resp.json())
```

--------------------------------

### Go example for revising a completed API

Source: https://docs.parse.bot/api-reference/dispatch/revise-a-completed-api

Uses the net/http package to send a POST request with a JSON payload. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.parse.bot/dispatch/tasks/{task_id}/revise"

	payload := strings.NewReader("{\n  \"revision\": \"<string>\",\n  \"contributes_to_marketplace\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

```

--------------------------------

### Python requests example for listing revision history

Source: https://docs.parse.bot/api-reference/dispatch/list-revision-history

Uses the requests library to GET the revision history endpoint. Prints the response text.

```python
import requests

url = "https://api.parse.bot/dispatch/tasks/{task_id}/revisions"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### JavaScript fetch example

Source: https://docs.parse.bot/api-reference/dispatch/list-your-apis

Uses fetch to GET the dispatch tasks endpoint with an X-API-Key header, parses the JSON response, and logs it or logs an error.

```javascript
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.parse.bot/dispatch/tasks?limit=50', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### 200 response example for previewing an endpoint update

Source: https://docs.parse.bot/api-reference/dispatch/preview-an-endpoint-update

Shows the JSON structure returned on success, including status, data, and sample_inputs fields.

```json
{
  "status": "<string>",
  "data": {},
  "sample_inputs": {}
}
```

--------------------------------

### parse help

Source: https://docs.parse.bot/sdk

Show the command overview.

```APIDOC
## parse help

### Description
Command overview.

### Command
`parse help [--json]`

### Parameters
#### Options
- `--json` (flag) - Optional - Output in JSON format.

### Usage
Run as `uv run parse help` or `parse help` in an activated venv.
```

--------------------------------

### JavaScript fetch example for listing revision history

Source: https://docs.parse.bot/api-reference/dispatch/list-revision-history

Uses fetch to GET the endpoint, parses the JSON response, and logs it. Handles errors with catch.

```javascript
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.parse.bot/dispatch/tasks/{task_id}/revisions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Add one of your own APIs with parse CLI

Source: https://docs.parse.bot/sdk

Lists your account APIs and adds one by slug, then syncs. Use `uv run parse list` to see slugs and `uv run parse add <slug>` to track an API.

```bash
uv run parse list               # see your account APIs and their slugs
uv run parse add my_zillow_api  # track it, then sync

```

--------------------------------

### 200 response example for creating a new API from a URL

Source: https://docs.parse.bot/api-reference/dispatch/create-a-new-api-from-a-url

Shows the JSON response returned on success, including task_id, matched, test_inputs, and may_require_auth fields.

```json
{
  "task_id": "<string>",
  "matched": true,
  "test_inputs": "<array>",
  "may_require_auth": false
}
```

--------------------------------

### PHP cURL example for listing revision history

Source: https://docs.parse.bot/api-reference/dispatch/list-revision-history

Uses PHP cURL to send a GET request with the X-API-Key header. Outputs the response or a cURL error.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.parse.bot/dispatch/tasks/{task_id}/revisions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Python requests example for previewing an endpoint update

Source: https://docs.parse.bot/api-reference/dispatch/preview-an-endpoint-update

Uses the requests library to POST to the preview-update endpoint with an empty params payload. Prints the response text.

```python
import requests

url = "https://api.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name}"

payload = { "params": {} }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

--------------------------------

### JavaScript fetch example for marketplace API detail

Source: https://docs.parse.bot/api-reference/marketplace/get-a-marketplace-apis-detail

Uses the Fetch API to GET the marketplace API detail and logs the parsed JSON response. No authentication is required.

```javascript
const options = {method: 'GET'};

fetch('https://api.parse.bot/marketplace/apis/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### GET search_papers

Source: https://docs.parse.bot/examples

Searches for papers on arxiv.org using query parameters such as query, author, title, category, sort_by, and start. Returns the endpoint's own JSON response.

```APIDOC
## GET search_papers

### Description
Searches for papers on arxiv.org using query parameters such as query, author, title, category, sort_by, and start. Returns the endpoint's own JSON response.

### Method
GET

### Endpoint
https://api.parse.bot/scraper/{scraper_id}/search_papers

### Parameters
#### Query Parameters
- **query** (string) - Optional - Search query text.
- **author** (string) - Optional - Author name to filter by.
- **title** (string) - Optional - Title keyword to filter by.
- **category** (string) - Optional - Category to filter by.
- **sort_by** (string) - Optional - Sorting criterion (e.g., relevance).
- **start** (integer) - Optional - Starting index for pagination.

### Request Example
```
GET https://api.parse.bot/scraper/9380e1b0-fae2-4340-9056-3d416f86c775/search_papers?query=diffusion%20models&sort_by=relevance
```

### Response
#### Success Response (200)
Returns the endpoint's own JSON response.

#### Response Example
```
{
  "results": []
}
```
```

--------------------------------

### Provide user input to resume build with POST /dispatch/{task_id}

Source: https://docs.parse.bot/quickstart

Responds to a needs_input status by providing the requested user input (e.g., a search term) to resume the build. The user_input_prompt field describes what is being asked.

```bash
curl -X POST https://api.parse.bot/dispatch/abc123-... \
  -H "X-API-Key: $PARSE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"user_response": {"search_term": "python"}}'
```

--------------------------------

### Successful response (200) from Parse.bot API

Source: https://docs.parse.bot/api-reference/execute/execute-an-api-endpoint-get

Example JSON response for a successful GET request (HTTP 200). It contains the scraped data fields such as `title`, `price`, and `rating`.

```json
{
  "title": "A Light in the Attic",
  "price": 51.77,
  "rating": 3
}
```

--------------------------------

### PHP cURL example for marketplace API detail

Source: https://docs.parse.bot/api-reference/marketplace/get-a-marketplace-apis-detail

Uses cURL in PHP to perform a GET request for the marketplace API detail and outputs the response or a cURL error. No authentication is required.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.parse.bot/marketplace/apis/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Call Parse Bot API with Python (httpx)

Source: https://docs.parse.bot/examples

Python client for calling GET endpoints on a Parse Bot scraper. Uses httpx with base URL and X-API-Key header. Includes examples for search_papers, get_paper, and get_category_taxonomy.

```python
import os
import httpx

SCRAPER_ID = "9380e1b0-fae2-4340-9056-3d416f86c775"

client = httpx.Client(
    base_url=f"https://api.parse.bot/scraper/{SCRAPER_ID}",
    headers={"X-API-Key": os.environ["PARSE_API_KEY"]},
    timeout=60,
)

def call(endpoint: str, **params):
    r = client.get(f"/{endpoint}", params=params)
    r.raise_for_status()          # raises on 4xx/5xx — see the Errors guide
    return r.json()

# Search for papers
results = call("search_papers", query="diffusion models", sort_by="relevance")
print(results)

# Fetch one paper's metadata
paper = call("get_paper", arxiv_id="2301.00001")
print(paper)

# Browse the category taxonomy (no params)
taxonomy = call("get_category_taxonomy")
print(taxonomy)

```

--------------------------------

### Python requests example to create a new API from a URL

Source: https://docs.parse.bot/api-reference/dispatch/create-a-new-api-from-a-url

Uses the requests library to POST the same payload to the dispatch endpoint. Sets X-API-Key and Content-Type headers, then prints the response text.

```python
import requests

url = "https://api.parse.bot/dispatch"

payload = {
    "url": "<string>",
    "task": "<string>",
    "contributes_to_marketplace": True,
    "allow_auth": False,
    "workspace": False
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

--------------------------------

### Call Parse Bot API with JavaScript (fetch)

Source: https://docs.parse.bot/examples

JavaScript client using fetch to call GET endpoints on a Parse Bot scraper. Uses URLSearchParams for query strings and X-API-Key header. Includes examples for search_papers, get_paper, and get_category_taxonomy.

```javascript
const SCRAPER_ID = "9380e1b0-fae2-4340-9056-3d416f86c775";
const BASE = `https://api.parse.bot/scraper/${SCRAPER_ID}`;
const headers = { "X-API-Key": process.env.PARSE_API_KEY };

async function call(endpoint, params = {}) {
  const qs = new URLSearchParams(params).toString();
  const res = await fetch(`${BASE}/${endpoint}?${qs}`, { headers });
  if (!res.ok) throw new Error(`${endpoint} ${res.status}: ${await res.text()}`);
  return res.json();
}

const results = await call("search_papers", { query: "diffusion models", sort_by: "relevance" });
console.log(results);

const paper = await call("get_paper", { arxiv_id: "2301.00001" });
console.log(paper);

const taxonomy = await call("get_category_taxonomy");
console.log(taxonomy);

```
Tokens:
Raw