Jobs

Poll work that outlived the request that started it

A tool that cannot finish inside one call enqueues instead, and answers with task_id. That id is this job_id.

Poll until terminal is true. A job that is still going carries Retry-After, which is the interval to use. result is filled once state is succeeded, error once it is failed.

A job is readable only by the member it belongs to.

get/api/jobs/{job_id}

Request

  • Base URL: https://youspot.com
  • URL: https://youspot.com/api/jobs/{job_id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://youspot.com/oauth/authorize, token URL https://youspot.com/oauth/token, scopes: linkedin)

Path parameters

job_idinteger required

The task_id a tool returned.

Response

The job as it stands.

successboolean required
job_idinteger required
kindstring required

What the job does, e.g. file_import.

state'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' required
terminalboolean required

True once the state can no longer change. Stop polling.

attemptsinteger

Runs so far, including the current one.

progressobject nullable

Whatever the job checkpoints as it goes. Shape depends on kind.

created_atstring date-time nullable
started_atstring date-time nullable
finished_atstring date-time nullable
resultobject nullable

Filled once state is succeeded.

errorstring nullable

Filled once state is failed.

Changes

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