Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
httpVersion
enum<string>

HTTP Version

Available options:
HTTP/1.0,
HTTP/1.1,
HTTP/2
statusCode
enum<string>

Status Code

Available options:
100|Continue,
101|Switching Protocols,
200|OK,
201|Created,
202|Accepted,
204|No Content,
206|Partial Content,
301|Moved Permanently,
302|Found,
303|See Other,
304|Not Modified,
307|Temporary Redirect,
308|Permanent Redirect,
400|Bad Request,
401|Unauthorized,
403|Forbidden,
404|Not Found,
405|Method Not Allowed,
409|Conflict,
410|Gone,
418|I'm a teapot,
422|Unprocessable Entity,
429|Too Many Requests,
500|Internal Server Error,
501|Not Implemented,
502|Bad Gateway,
503|Service Unavailable,
504|Gateway Timeout
reasonOverride
string

Reason Phrase

bodyType
enum<string>

Body Type

Available options:
none,
text,
json,
xml,
html,
form
body
string

Body

autoContentType
boolean

Auto-set Content-Type from Body Type

autoContentLength
boolean

Auto-calculate Content-Length

date
string

Date Header

customHeaders
string

Custom Headers

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.