Jobs

Schedule a job

Create a new job.

post/projects/{owner}/{name}/jobs

Request

Base URL
https://api.pollination.solutions (the document declares no server; this is the origin it was published from)
Auth
- HTTP bearer
- or API key in header x-pollination-token
TypeScript
https://skmtc.dev/pollination/apis/pollination-server/docs/projects/:owner/:name/jobs/post.ts
A function with typed inputs. Its response is checked against the schema.

ownerstring required

namestring required

authorizationstring

x-pollination-tokenstring

typestring

annotationsobject

An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries.

api_versionstring

sourcestring required

The source url for downloading the recipe.

namestring

An optional name for this job. This name will be used a the display name for the run.

descriptionstring

Run description.

labelsobject

Optional user data as a dictionary. User data is for user reference only and will not be used in the execution of the job.

Successful Response

idstring uuid required

Id for the newly created resource.

messagestring

A human readable message

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "Use Location in headers to access the new object."
}

No recorded changes to this operation across all 1 revision of this API.