Tasks Runs Input Get

GET

tasks

runs

{run_id}

input

curl --request GET \
  --url https://api.parallel.ai/v1/tasks/runs/{run_id}/input \
  --header 'x-api-key: <api-key>'

{
  "task_spec": {
    "output_schema": {
      "json_schema": {
        "additionalProperties": false,
        "properties": {
          "gdp": {
            "description": "GDP in USD for the year, formatted like '$3.1 trillion (2023)'",
            "type": "string"
          }
        },
        "required": [
          "gdp"
        ],
        "type": "object"
      },
      "type": "json"
    },
    "input_schema": {
      "json_schema": {
        "additionalProperties": false,
        "properties": {
          "gdp": {
            "description": "GDP in USD for the year, formatted like '$3.1 trillion (2023)'",
            "type": "string"
          }
        },
        "required": [
          "gdp"
        ],
        "type": "object"
      },
      "type": "json"
    }
  },
  "input": "France (2023)",
  "processor": "<string>",
  "metadata": {}
}

Authorizations

x-api-key

string

header

required

Path Parameters

run_id

string

required

Response

200

application/json

Successful Response

Request to run a task.

input

required

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

Example:

"France (2023)"

processor

string

required

Processor to use for the task.

task_spec

object | null

Task specification.

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.

task_spec.output_schema.json_schema

object

required

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

Example:

{
  "additionalProperties": false,
  "properties": {
    "gdp": {
      "description": "GDP in USD for the year, formatted like '$3.1 trillion (2023)'",
      "type": "string"
    }
  },
  "required": ["gdp"],
  "type": "object"
}

task_spec.output_schema.type

enum<string>

default:json

The type of schema being defined. Always json.

Available options:

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.

task_spec.input_schema.json_schema

object

required

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

Example:

{
  "additionalProperties": false,
  "properties": {
    "gdp": {
      "description": "GDP in USD for the year, formatted like '$3.1 trillion (2023)'",
      "type": "string"
    }
  },
  "required": ["gdp"],
  "type": "object"
}

task_spec.input_schema.type

enum<string>

default:json

The type of schema being defined. Always json.

Available options:

json

metadata

object | null

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

Tasks Runs Result GetRetrieves a run by run_id, blocking until the run is completed.

curl --request GET \
  --url https://api.parallel.ai/v1/tasks/runs/{run_id}/input \
  --header 'x-api-key: <api-key>'

{
  "task_spec": {
    "output_schema": {
      "json_schema": {
        "additionalProperties": false,
        "properties": {
          "gdp": {
            "description": "GDP in USD for the year, formatted like '$3.1 trillion (2023)'",
            "type": "string"
          }
        },
        "required": [
          "gdp"
        ],
        "type": "object"
      },
      "type": "json"
    },
    "input_schema": {
      "json_schema": {
        "additionalProperties": false,
        "properties": {
          "gdp": {
            "description": "GDP in USD for the year, formatted like '$3.1 trillion (2023)'",
            "type": "string"
          }
        },
        "required": [
          "gdp"
        ],
        "type": "object"
      },
      "type": "json"
    }
  },
  "input": "France (2023)",
  "processor": "<string>",
  "metadata": {}
}