LettaAPI.Api.Jobs (letta_api v1.0.0)

API calls for all endpoints tagged Jobs.

Summary

Functions

Delete Job Delete a job by its job_id.

List Active Jobs List all active jobs.

List Jobs List all jobs.

Retrieve Job Get the status of a job.

Functions

delete_job(connection, job_id, opts \\ [])

@spec delete_job(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, LettaAPI.Model.Job.t()}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Delete Job Delete a job by its job_id.

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • job_id (String.t):
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, LettaAPI.Model.Job.t} on success
  • {:error, Tesla.Env.t} on failure

list_active_jobs(connection, opts \\ [])

@spec list_active_jobs(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [LettaAPI.Model.Job.t()]}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

List Active Jobs List all active jobs.

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, [%Job{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

list_jobs(connection, opts \\ [])

@spec list_jobs(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [LettaAPI.Model.Job.t()]}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

List Jobs List all jobs.

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :source_id (String.t): Only list jobs associated with the source.
    • :user_id (String.t):

Returns

  • {:ok, [%Job{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

retrieve_job(connection, job_id, opts \\ [])

@spec retrieve_job(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, LettaAPI.Model.Job.t()}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Retrieve Job Get the status of a job.

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • job_id (String.t):
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, LettaAPI.Model.Job.t} on success
  • {:error, Tesla.Env.t} on failure