Run one job of a Buddy package on the server

Queues a Run and answers at once. Poll the Run until its status is `completed` or `failed`.

Authorization

ApiKey

AuthorizationBearer <token>

Bearer API key in the form sk_live_…, sk_test_…, or pk_live_…. Keys are issued from the Signature dashboard and carry product-prefixed scopes.

In: header

Path Parameters

slug*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

job*string

input?unknown

The job's input; the package's own schema checks it.

surface?string

version?string

Response Body

`application/json`

curl -X POST "https://example.com/buddy_packages/string/runs" \  -H "Content-Type: application/json" \  -d '{    "job": "string"  }'

{  "id": "string",  "object": "buddy_run",  "package": "string",  "job": "string",  "surface": "web",  "status": "queued",  "output": {    "property1": null,    "property2": null  },  "artefacts": [    {      "id": "string",      "path": "string",      "content_type": "string",      "size_bytes": 0    }  ],  "issues": [    {      "code": "string",      "message": "string",      "port": "string"    }  ],  "error": {    "code": "timeout",    "message": "string"  },  "queued": "2019-08-24T14:15:22Z",  "started": "2019-08-24T14:15:22Z",  "finished": "2019-08-24T14:15:22Z",  "cpu_ms": 0}