Task Requests


This documentation is intended for our legacy V1 system and may be outdated.

Method

GET
Typically used to indicate we are reading a resource
POST
Typically used to indicate we are creating a resource
PUT & PATCH
Typically used to indicate we are modifying a resource
DELETE
Typically used to indicate we are deleting a resource

Scheme

We support either http or https to indicate a secure connection.

Host

This is the service we intend on talking to. E.g. api.server.com would be a host.

Path

This is the specific path the request will make to the server. E.g. a path could be /resources/123 to indicate a request to a specific resource.

Headers

HTTP headers are a collection of key value pairs sent to the server. They are often used to send authentication credentials as they are considered more secure than other parts of the request which are not usually logged.

Body

Some requests can have a body, which could be structured JSON, free text or binary form data. It is common for most tasks to not have a body.