About

Blog

Outropy

API Reference

Dashboard

Support

Retrieve informationa about a Task Run.

This will return its status and execution related information.

The URN can be found in the 'urn' field of the response from the [Execute Task](/api-reference/endpoint/execute-task) endpoint.

Get Task Run

Location

Message

Error Type

ValidationError

TaskRunResponse

HTTPValidationError

Welcome

Transform

Introduction

Create a new Task using the following information:


<Note>
    Creation will fail if an existing task with the same name and type already exists.
</Note>
<Note>
    Not all tasks types support all the fields, see each task documentation for more details.
</Note>

Create new Task

Execute a task with the given input.
Tasks are executed asynchronously, this will return a URN for the task run which can be used to retrieve the results later.

Execute Task

Retrieve the inputs used for a given task run.

Those inputs can be used to re-execute the run with the same task or a similar one.
See the [Execute Task](/api-reference/endpoint/execute-task) endpoint for more details.

Get Run Inputs

Upload data to Outropy.

The uploaded content currently must be text-based.

This returns the URN of the uploaded file.

The returned URN can be used as subject when executing tasks.

<Note>  
    You must specify the file's mime type in the `X-Outropy-Upload-Mime-Type` header.
</Note>

Upload Data

Fetch data by URN.

The downloaded data is returned as plain text.

<Note>
    See the [Upload Data](/api-reference/endpoint/upload-data) endpoint for more details on how to upload data.
</Note>

<Note>
    In order to fetch the file name and mime type, use the [Get File Metadata](/api-reference/endpoint/get-file-metadata) endpoint.
</Note>

Download Data

Retrieve metadata for a file by URN.

The metadata includes the file name, mime type, size in bytes, and any additional metadata.


<Note>
    See the [File Metadata](/file-metadata) for explanation of how additinal metadata is used by the Outropy platform.
</Note>

API Documentation

Endpoints

Get Task Run

Path Parameters

Response