Retrieve Task Run Input

import requests

url = "https://api.parallel.ai/v1/tasks/runs/{run_id}/input"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

{
  "processor": "<string>",
  "input": "What was the GDP of France in 2023?",
  "metadata": {},
  "source_policy": {
    "include_domains": [
      "<string>"
    ],
    "exclude_domains": [
      "<string>"
    ]
  },
  "task_spec": {
    "output_schema": {
      "json_schema": {},
      "type": "json"
    },
    "input_schema": "<string>"
  }
}

GET

tasks

runs

{run_id}

input

Retrieve Task Run Input

import requests

url = "https://api.parallel.ai/v1/tasks/runs/{run_id}/input"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

{
  "processor": "<string>",
  "input": "What was the GDP of France in 2023?",
  "metadata": {},
  "source_policy": {
    "include_domains": [
      "<string>"
    ],
    "exclude_domains": [
      "<string>"
    ]
  },
  "task_spec": {
    "output_schema": {
      "json_schema": {},
      "type": "json"
    },
    "input_schema": "<string>"
  }
}

Authorizations

x-api-key

string

header

required

Path Parameters

run_id

string

required

Response

Successful Response

Request to run a task.

processor

string

required

Processor to use for the task.

input

required

Input to the task, either text or a JSON object.

Example:

"What was the GDP of France in 2023?"

metadata

Metadata · object

User-provided metadata stored with the run. Keys and values must be strings with a maximum length of 16 and 512 characters respectively.

Show child attributes

metadata.{key}

source_policy

SourcePolicy · object

Optional source policy governing preferred and disallowed domains in web search results.

Show child attributes

source_policy.include_domains

string[]

List of domains to restrict the results to. If specified, only sources from these domains will be included. Accepts plain domains (e.g., example.com, subdomain.example.gov) or bare domain extension starting with a period (e.g., .gov, .edu, .co.uk).

source_policy.exclude_domains

string[]

List of domains to exclude from results. If specified, sources from these domains will be excluded. Accepts plain domains (e.g., example.com, subdomain.example.gov) or bare domain extension starting with a period (e.g., .gov, .edu, .co.uk).

task_spec

TaskSpec · object

Task specification. If unspecified, defaults to auto output schema.

Show child attributes

task_spec.output_schema

required

JSON schema or text fully describing the desired output from the task. Descriptions of output fields will determine the form and content of the response. A bare string is equivalent to a text schema with the same description.

Show child attributes

task_spec.output_schema.json_schema

Json Schema · object

required

A JSON Schema object. Only a subset of JSON Schema is supported.

task_spec.output_schema.type

string

default:json

The type of schema being defined. Always json.

Allowed value: "json"

task_spec.input_schema

Optional JSON schema or text description of expected input to the task. A bare string is equivalent to a text schema with the same description.

Retrieve Task Run Retrieve Task Run Result

⌘I

Extract (Beta)

Search (Beta)

Monitor

Tasks v1

Tasks (Beta)

FindAll API (Beta)

Retrieve Task Run Input

Authorizations

Path Parameters

Response